From 024cfbb3f636a76f627a2fa6f03acd6d99fcc5db Mon Sep 17 00:00:00 2001 From: Tsvetoslav Dimov Date: Mon, 13 Nov 2023 15:52:28 +0000 Subject: [PATCH] docs: add new use-cases --- README.md | 5 ++++- cmd/followdata/root.go | 2 +- docs/instagram_followdata_followers.md | 1 + docs/instagram_followdata_following.md | 1 + docs/instagram_followdata_unfollowers.md | 1 + 5 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d71f6f2..61c3be0 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,10 @@ Discover various insights from your Instagram data. ## Use-cases - Find out which users are not following you back -- Export followers and following user lists in various formats (JSON, YAML, Table) +- Export followers and following user lists in various formats (table, json, yaml) +- Sort the results by various criteria in ascending or descending order +- Set sorting criteria and order direction of the results +- Limit the number of results to get a quick overview (e.g. top 10) ## Prerequisites Complete all steps from this section. diff --git a/cmd/followdata/root.go b/cmd/followdata/root.go index 3b3c07f..8a99670 100644 --- a/cmd/followdata/root.go +++ b/cmd/followdata/root.go @@ -28,7 +28,7 @@ func NewRootCommand() *cobra.Command { } func addCommonFlags(cmd *cobra.Command) { - cmd.Flags().Int(instagram.FlagLimit, instagram.Unlimited, `maximum results to display, leave empty for unlimited`) + cmd.Flags().Int(instagram.FlagLimit, instagram.Unlimited, `max results to display, omit this flag or set to 0 for unlimited`) cmd.Flags().String(instagram.FlagOrder, instagram.OrderDesc, `order direction ("asc", "desc")`) cmd.Flags().String(instagram.FlagOutput, instagram.OutputTable, `output format ("json", "table", "yaml")`) cmd.Flags().String(instagram.FlagSortBy, instagram.FieldTimestamp, `sort by field ("timestamp", "username")`) diff --git a/docs/instagram_followdata_followers.md b/docs/instagram_followdata_followers.md index 5425db1..b99616a 100644 --- a/docs/instagram_followdata_followers.md +++ b/docs/instagram_followdata_followers.md @@ -10,6 +10,7 @@ instagram followdata followers [flags] ``` -h, --help help for followers + --limit int max results to display, omit this flag or set to 0 for unlimited --order string order direction ("asc", "desc") (default "desc") --output string output format ("json", "table", "yaml") (default "table") --sort-by string sort by field ("timestamp", "username") (default "timestamp") diff --git a/docs/instagram_followdata_following.md b/docs/instagram_followdata_following.md index c6cae21..b53c48c 100644 --- a/docs/instagram_followdata_following.md +++ b/docs/instagram_followdata_following.md @@ -10,6 +10,7 @@ instagram followdata following [flags] ``` -h, --help help for following + --limit int max results to display, omit this flag or set to 0 for unlimited --order string order direction ("asc", "desc") (default "desc") --output string output format ("json", "table", "yaml") (default "table") --sort-by string sort by field ("timestamp", "username") (default "timestamp") diff --git a/docs/instagram_followdata_unfollowers.md b/docs/instagram_followdata_unfollowers.md index 4eca1df..f4917e8 100644 --- a/docs/instagram_followdata_unfollowers.md +++ b/docs/instagram_followdata_unfollowers.md @@ -10,6 +10,7 @@ instagram followdata unfollowers [flags] ``` -h, --help help for unfollowers + --limit int max results to display, omit this flag or set to 0 for unlimited --order string order direction ("asc", "desc") (default "desc") --output string output format ("json", "table", "yaml") (default "table") --sort-by string sort by field ("timestamp", "username") (default "timestamp")