diff --git a/README.md b/README.md new file mode 100644 index 0000000..269203e --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Hermes + +Save and sync your ssh config in private repository + +*Disclaimer* +``` +- Use with your own risk +- Never use public repository to save your config +``` + +## Installation + +`tba` + +## How to Use + +- Create your private repository to save the config, add config there with format example in `example/config.yaml` +- Run `hermes init ${your_private_url_repository}` +- Run `hermes connect ${hostname}` + +## How to Remove Local Config + +- Run `hermes destroy`