summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStuart Stock <stuart@int08h.com>2017-07-06 08:31:14 -0500
committerStuart Stock <stuart@int08h.com>2017-07-06 08:31:14 -0500
commit3cb57d473b6b26f81c2ded1dae326c971921b84e (patch)
treeb38441c74ca96be456c601c7f4ef13d90bd8344a /README.md
parent824a9ca7130d359014a35b5b180f6b72298f2f7b (diff)
downloadroughenough-3cb57d473b6b26f81c2ded1dae326c971921b84e.zip
update README with implementation limitations
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index bc79eeb..25c2b63 100644
--- a/README.md
+++ b/README.md
@@ -7,8 +7,9 @@ It is a **work in progress**. Current status:
* Server is functionally complete: it parses requests and generates valid Roughtime responses.
* Still TODO:
* Run-time configuration (udp port, listening interface, etc)
- * Reading the long-term key
- * Better operational ergonomics like logging
+ * Loading the long-term key
+ * Better operational ergonomics
+
## About the Roughtime Protocol
[Roughtime](https://roughtime.googlesource.com/roughtime) is a protocol that aims to achieve rough
@@ -29,6 +30,12 @@ Use `cargo` to compile and run the server binary:
```bash
$ cargo run --bin server
```
+
+## Limitations
+
+Roughenough does not implement the response fault-injection Roughtime ecosystem feature.
+On-line delegated key rotation is also not implemented; the server must be restarted to
+generate a new delegated key.
## Contributors
* Stuart Stock, original author and current maintainer (stuart {at} int08h.com)