Skip to content

Commit

Permalink
docs(README): update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
sdttttt committed Oct 10, 2020
1 parent 808b91c commit 798561e
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@

Standardized Git submission tool. “Grc” is a temporary name.

Similar to git-cz, gcr will help you to provide a better Git experience.
Similar to git-cz, grc will help you to provide a better Git experience.

## Install

You can install **grc** in the following ways:

### From Cargo

Please Run `cargo install grc`.
Please Run:

```sh
cargo install grc
```

### Release Package

Expand All @@ -27,7 +31,7 @@ Go to [RELEASE](https://github.com/sdttttt/gcr/releases), download one you like.

Please Run:

```bash
```sh
git clone --depth=1 https://github.com/sdttttt/gcr.git

cd gcr
Expand All @@ -41,10 +45,20 @@ grc under `target/release/`.

after the tools install, run command in your repository:

```
```sh
grc
```

## Progress
GRC can also automatically help you add files to the index.

```sh
//Add all files
grc -a .

// Add specified file
grc -a <filename>...
```

## IDEA

GRC is still a child at present. About its training ~~(develop)~~ progress. The progress of it is in [project](https://github.com/sdttttt/gcr/projects).
If you have any new ideas, you are welcome to talk to me.

0 comments on commit 798561e

Please sign in to comment.