chore: add readme docs

envycode · Dec 6, 2020 · 17cfd9e · 17cfd9e
1 parent e455328
commit 17cfd9e
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md 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`