docs: add new use-cases

cecobask · Nov 13, 2023 · 024cfbb · 024cfbb
1 parent 65be4e5
commit 024cfbb
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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")