Merge pull request #16 from gkze/add-cmd

Introduce feature to bulk star repositories

.goreleaser.yml

@@ -11,23 +11,25 @@ before:
   - go mod tidy
 brews:
 - commit_author:
-    email: "george.kontridze@gmail.com"
+    email: george.kontridze@gmail.com
     name: gkze
   description: Explore your Github stars
   folder: Formula
   github:
-    name: "homebrew-gkze"
+    name: homebrew-gkze
     owner: gkze
   homepage: "https://github.com/gkze/stars"
   test: "system  \"#{bin}/stars -v\""
 builds:
-- main: ./cmd/stars/stars.go
-  binary: stars
+- binary: stars
   env:
-  - "GO111MODULE=on"
-  - "CGO_ENABLED=0"
+  - GO111MODULE=on
+  - CGO_ENABLED=0
+  goarch:
+  - amd64
   ldflags:
-  - -X main.Version={{.Version}}
+  - "-X main.Version={{.Version}}"
+  main: "./cmd/stars/stars.go"
 changelog:
   filters:
     exclude:
@@ -36,7 +38,7 @@ changelog:
   sort: asc
 checksum:
   name_template: checksums.txt
-sign:
-  artifacts: checksum
+signs:
+- artifacts: checksum
 snapshot:
   name_template: "{{ .Tag }}-next"

README.md

@@ -1,5 +1,18 @@
 # stars
 
+[![Actions Test Workflow Widget]][Actions Test Workflow Status]
+[![GoReport Widget]][GoReport Status]
+[![GoDocWidget]][GoDocReference]
+
+[Actions Test Workflow Status]: https://github.com/gkze/stars/actions?query=workflow%3ATest
+[Actions Test Workflow Widget]: https://github.com/gkze/stars/workflows/Test/badge.svg
+
+[GoReport Status]: https://goreportcard.com/report/github.com/gkze/stars
+[GoReport Widget]: https://goreportcard.com/badge/github.com/gkze/stars
+
+[GoDocWidget]: https://godoc.org/github.com/gkze/stars?status.svg
+[GoDocReference]:https://godoc.org/github.com/gkze/stars
+
 A command-line interface to your Github Stars. Some useful features:
 
 * Downloads metadata about all of your starred projects and saves it to disk
@@ -12,9 +25,6 @@ A command-line interface to your Github Stars. Some useful features:
 * Can limit displayed results as specified
 * Can open queried starred projects in your browser for viewing
 
-**_NOTE:_** Currently only macOS is supported. Support for other platforms will
-be considered if there is demand.
-
 My personal workflow is to save all of my stars, prune old and archived ones,
 and display several random stars in my browser for me to view / explore. This
 is a type of [Spaced Repetation Learning](https://en.wikipedia.org/wiki/Spaced_repetition)
@@ -70,24 +80,32 @@ machine api.github.com
 ## Usage
 
 ```bash
-NAME:
-   stars - Command-line interface to your GitHub stars
-
-USAGE:
-   stars [global options] command [command options] [arguments...]
-
-VERSION:
-   0.4.15
-
-COMMANDS:
-     save     Save all stars
-     topics   list all topics of starred projects
-     show     Show popular stars given filters
-     clear    Clear local stars cache
-     cleanup  Clean up old stars
-     help, h  Shows a list of commands or help for one command
-
-GLOBAL OPTIONS:
-   --help, -h     show help
-   --version, -v  print the version
+A CLI written in Golang to facilitate efficient management of a user's
+GitHub starred projects / repositories, a.k.a. "Stars"
+
+Usage:
+  stars [flags]
+  stars [command]
+
+Available Commands:
+  add         Add (star) repositories
+  cleanup     Clean up old stars
+  clear       Clear local stars cache
+  completion  Generate shell completion script
+  help        Help about any command
+  save        Save starred repositories
+  show        Show stars
+  topics      List all topics of all stars
+  version     Show version of stars
+
+Flags:
+  -w, --concurrency int    Limit goroutines for network I/O operations (default 10)
+  -h, --help               help for stars
+  -o, --log-level string   Log level (default "info")
+
+Use "stars [command] --help" for more information about a command.
 ```
+
+# License
+
+[MIT](LICENSE)