diff --git a/README.md b/README.md index 522fa61..6fc557a 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,29 @@ machine. The goal is to have a _single_ "repositories" file that can be synced across devices. Shepherd would take this file, allow for syncing repository configurations and bulk operations (fetch, unified log, etc). + +## Building + +1. Grab the source from [git.nixnet.services/boots/shepherd](https://git.nixnet.services/boots/shepherd). +2. Build using `cargo build --release` + +## Basic Usage + +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. + +To add a repository to shepherd: +``` +shepherd add +``` + +To list out currently tracked repositories: +``` +shepherd list +``` + +To clone and update all tracked repositories: +``` +shepherd fetch +```