Update README and help message
This commit is contained in:
parent
d1592e83a5
commit
13b5d679e6
|
@ -19,9 +19,11 @@ The help message can be displayed by running `shepherd --help`.
|
||||||
|
|
||||||
The default path to the configuration file is `~/config/shepherd/config.toml`; however, a different location can be specified with the `--config` flag.
|
The default path to the configuration file is `~/config/shepherd/config.toml`; however, a different location can be specified with the `--config` flag.
|
||||||
|
|
||||||
|
If a category is specified when adding a repository, it will show up in a folder under your root `source_dir` folder, which can be set in your `config.toml`.
|
||||||
|
|
||||||
To add a repository to shepherd:
|
To add a repository to shepherd:
|
||||||
```
|
```
|
||||||
shepherd add <name> <git-url>
|
shepherd add [--category | -c <category>] <name> <git-url>
|
||||||
```
|
```
|
||||||
|
|
||||||
To list out currently tracked repositories:
|
To list out currently tracked repositories:
|
||||||
|
|
|
@ -85,7 +85,7 @@ impl State {
|
||||||
let name: Option<String>;
|
let name: Option<String>;
|
||||||
match next {
|
match next {
|
||||||
Some(ref x) => match &x[..] {
|
Some(ref x) => match &x[..] {
|
||||||
"--category" => {
|
"--category" | "-c" => {
|
||||||
state.category = args.next();
|
state.category = args.next();
|
||||||
name = args.next();
|
name = args.next();
|
||||||
}
|
}
|
||||||
|
@ -93,7 +93,6 @@ impl State {
|
||||||
},
|
},
|
||||||
None => name = None,
|
None => name = None,
|
||||||
}
|
}
|
||||||
eprintln!("Category: {:?}", name);
|
|
||||||
match name {
|
match name {
|
||||||
Some(x) => {
|
Some(x) => {
|
||||||
state.name = Some(x);
|
state.name = Some(x);
|
||||||
|
@ -276,6 +275,7 @@ OPTIONS:
|
||||||
-h, --help Print out this help message
|
-h, --help Print out this help message
|
||||||
--config Specify the location of the configuration file
|
--config Specify the location of the configuration file
|
||||||
--dump-config Dump the current configuration
|
--dump-config Dump the current configuration
|
||||||
|
-c, --category Specify the category when adding a repository
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
General
|
General
|
||||||
|
|
Loading…
Reference in New Issue