Update README, add config example

revault · Apr 6, 2021 · ef5a23c · ef5a23c
1 parent 52d7aea
commit ef5a23c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 
 The anti-replay oracle used under the [Revault architecture](https://github.com/revault/practical-revault/blob/master/revault.pdf).
 
+## Usage
+`cosignerd` must be used along with `revaultd`. Check `revaultd's` [tutorial](https://github.com/revault/revaultd/tree/master/doc/USAGE.md) to get started!
+
 ## Licence
 
 BSD 3-clauses, see [LICENSE](LICENSE).
diff --git a/contrib/config_regtest.toml b/contrib/config_regtest.toml
@@ -0,0 +1,8 @@
+daemon = false
+log_level = "trace"
+data_dir = "/path/to/your/data_dir"
+listen = "0.0.0.0:8383"
+
+# Put here the managers xpubs and noise keys. The noise key can be obtained starting `revaultd`.
+managers = [{ xpub = "xpub6CFH8m3bnUFXvS78XZyCQ9mCbp7XmKXbS67YHGUS3NxHSLhAMCGHGaEPojcoYt5PYnocyuScAM5xuDzf4BqFQt3fhmKEaRgmVzDcAR46Byh", noise_key = "b28cf2091bbbecf347d29420f884a936713e7b2e86fe4f6653d7e12356d26114" },
+{ xpub = "xpub6ECZqYNQzHkveSWmsGh6XSL8wMGXRtoZ5hkbWXwRSVEyEsKADe34dbdnMob1ZjUpd4TD7no1isnnvpQq9DchFes5DnHJ7JupSntZsKr7VbQ", noise_key = "b28cf2091bbbecf347d29420f884a936713e7b2e86fe4f6653d7e12356d26114" },]