summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorBen Morrison <ben@gbmor.dev>2019-05-20 04:40:35 -0400
committerBen Morrison <ben@gbmor.dev>2019-05-20 04:40:35 -0400
commitef0ee9137ee5cedf5327fa9908e88c155c49ae8f (patch)
tree347705efa9f8e242abeda8a5af9862a42827ed9a
parent1168570b071d8bb483e4028f3a8c45a222c93ecb (diff)
downloadgetwtxt-ef0ee9137ee5cedf5327fa9908e88c155c49ae8f.tar.gz
updated readme
-rw-r--r--README.md30
1 files changed, 22 insertions, 8 deletions
diff --git a/README.md b/README.md
index abe557f..ad81841 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,24 @@
 # getwtxt [![Build Status](https://travis-ci.com/getwtxt/getwtxt.svg?branch=master)](https://travis-ci.com/getwtxt/getwtxt)
 
-twtxt registry written in Go. Still in very early development. I'm a bit
-obsessive over personal projects, though, so it should advance quickly.
-
-**Update 2019-05-19**
-  * I decided to branch off the registry utility functions into a library, 
-so that's what I've been working on the last few days. They are available
-at [github.com/getwtxt/registry](https://github.com/getwtxt/registry). Now
-that I've completed the library, I can return to this side of the project.
+twtxt registry written in Go. Still in development. 
+
+*  Began: 10 May 2019
+*  No deadline. Should be finished by the end of May 2019.
+
+## Roadmap
+
+Checks indicate steps I've finished. The first blank box is what I'm working on.
+
+* [x] Types and basic init/config
+* [x] HTTP routing
+* [x] Handlers stubbed out
+* [x] Registry manipulation ([getwtxt/registry](https://github.com/getwtxt/registry))
+* [ ] Request handling
+* [ ] Persistent data storage
+* [ ] Catch up on tests / Concurrency safety checks
+* [ ] Refactor and optimize
+
+## Notes
+
+* twtxt
+  * [twtxt.readthedocs.io](https://twtxt.readthedocs.io)