Increase version

- Increase version to `v0.3.1`. - Update `README.md` with latest screenshots. - Add new install instructions using `cargo install`. - Add screenshots to docs directory.
aslamplr · May 15, 2020 · 4abb69b · 4abb69b
1 parent 361ca4c
commit 4abb69b
Show file tree

Hide file tree

Showing 11 changed files with 30 additions and 10 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "gh-cli"
-version = "0.3.0"
+version = "0.3.1"
 authors = ["Aslam Ahammed <aslamplr@gmail.com>"]
 edition = "2018"
 license = "MIT"

diff --git a/README.md b/README.md
@@ -1,27 +1,48 @@
 # gh-cli 
 named `gh-actions-secrets` earlier, renamed to `gh-cli`.
 
+## Install
+
+### Option 1
+Download pre-compiled binaries for MacOS, Ubuntu and Windows from the release page.  
+
 [🗃 » Download the latest release «](https://github.com/aslamplr/gh-cli/releases)
 
-![cmd](docs/5ED19EF9-972D-432A-82FE-F7686A6232DF.png)
+### Option 2
+If you have installed `cargo` you may proceed to install this CLI using cargo. Note that while installing with cargo, cargo will try to build this crate from source. 
+
+```
+cargo install --git https://github.com/aslamplr/gh-cli.git --tag v0.3.1
+```
+
+You may install `cargo` along with `rust`, follow the [rust install instructions from here](https://www.rust-lang.org/tools/install)
+
+
+![cmd](docs/gh-cli.png)
 
 ## Sub Commands
 
+### Repo
+![repo-cmd](docs/gh-cli-repo.png)
+
+#### Example
+![repo-cmd-sample](docs/gh-cli-repo_sample.png)
+
 ### Secrets
-![secrets-cmd](docs/8F520E9E-9721-49C5-B560-D281D95B1375.png)
+![secrets-cmd](docs/gh-cli-secrets.png)
 
 #### Example
 
 **Add new secret to Github actions secrets**
 
 ```
-gh-cli secrets --auth_token=qwertyuipasdfghjklzxcvbnmlkgsdfg --repo_owner aslamplr --repo_name gh-actions-secrets --action add --secret_key SECRET_KEY --secret_value SECRET_VALUE_XYZ_BLAH_BLAH
+gh-cli secrets --auth_token=qwertyuipasdfghjklzxcvbnmlkgsdfg --name aslamplr/gh-cli --action add --secret_key SECRET_KEY --secret_value SECRET_VALUE_XYZ_BLAH_BLAH
 ```
 
 **List all secrets**
 
 ```
-gh-cli secrets --auth_token=qwertyuipasdfghjklzxcvbnmlkgsdfg --repo_owner aslamplr --repo_name gh-actions-secrets --action list
+gh-cli secrets --auth_token=qwertyuipasdfghjklzxcvbnmlkgsdfg --name aslamplr/gh-cli --action list
 ```
 
 ## Development

diff --git a/docs/.gitkeep b/docs/.gitkeep
diff --git a/docs/5ED19EF9-972D-432A-82FE-F7686A6232DF.png b/docs/5ED19EF9-972D-432A-82FE-F7686A6232DF.png
diff --git a/docs/8F520E9E-9721-49C5-B560-D281D95B1375.png b/docs/8F520E9E-9721-49C5-B560-D281D95B1375.png
diff --git a/docs/gh-cli-repo.png b/docs/gh-cli-repo.png
diff --git a/docs/gh-cli-repo_sample.png b/docs/gh-cli-repo_sample.png
diff --git a/docs/gh-cli-secrets.png b/docs/gh-cli-secrets.png
diff --git a/docs/gh-cli.png b/docs/gh-cli.png
diff --git a/src/main.rs b/src/main.rs
@@ -9,7 +9,7 @@ use gh_cli::core::{
 #[derive(Clap)]
 #[clap(
     name = "GitHub CLI",
-    version = "v0.3.0",
+    version = "v0.3.1",
     author = "Aslam Ahammed A. <aslamplr@gmail.com>",
     about = r#"Yet another unofficial GitHub CLI!
 Minimalistic, opinionated, and unofficial by default.
@@ -30,7 +30,7 @@ enum SubCommand {
 #[derive(Clap)]
 #[clap(
     name = "GitHub Repo CLI",
-    version = "v0.3.0",
+    version = "v0.3.1",
     author = "Aslam Ahammed A. <aslamplr@gmail.com>",
     about = "GitHub Repo CLI"
 )]
@@ -62,7 +62,7 @@ struct Repo {
 #[derive(Clap)]
 #[clap(
     name = "GitHub Actions Secrets CLI",
-    version = "v0.3.0",
+    version = "v0.3.1",
     author = "Aslam Ahammed A. <aslamplr@gmail.com>",
     about = "GitHub Actions Secrets CLI wrapper for GitHub Actions Secrets API"
 )]