archive/dotfile-automator
Archived
1
Fork 0
Code Releases Packages Activity

Added usage

Browse source
This commit is contained in:
Jake Howard 2016-01-05 21:25:13 +00:00
parent fbe5ee4423
commit deb85e92f2
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -19,3 +19,25 @@ After installation, you can test the tool is installed correctly by running:
dfa --help dfa --help
If help text is displayed, you're good to go! If not, try repeating the installation steps again, or posting an issue on the issues page. If help text is displayed, you're good to go! If not, try repeating the installation steps again, or posting an issue on the issues page.
## Usage
Using `dfa` is very simple, just follow these simple steps:
`dfa config set public_repo <repo-url>`
Set the repo that contains your public data. Replacing `<repo-url>` with the location of your repo, supports both HTTPS and SSH, as well as any Git host.
`dfa config set private_repo <repo-url>` (optional)
Same as previous, but allows you to add private data from outside your main repo, presumably from a private repo. Useful for things like SSH keys, or sensetive environment variables.
`dfa sync [--private]`
Clones the repo into the local directory. Add the `--private` flag to clone the private repo as well, if configured.
`dfa export [sections ...]`
Where the magic happens! Exports the data using presets for certain data types, or can be extended using a [`Make` file](https://en.wikipedia.org/wiki/Makefile). See wiki for how to extend this, and how the presets work. You can specify `sections` to run, that run only the specific sections from the presets, and then from the make file.