diff options
author | Ben Morrison <ben@gbmor.dev> | 2019-05-22 00:37:22 -0400 |
---|---|---|
committer | Ben Morrison <ben@gbmor.dev> | 2019-05-22 00:45:53 -0400 |
commit | e3a24e26be6eac0a976b0f267bfb83e18410a465 (patch) | |
tree | 5525e105ddfbe8e20256dbd34d15532acb97226f | |
parent | e0bacf4df35f6dbd73559093387763bb909df5b1 (diff) | |
download | getwtxt-e3a24e26be6eac0a976b0f267bfb83e18410a465.tar.gz |
updated readme
-rw-r--r-- | README.md | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/README.md b/README.md index d06628f..f758cf8 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,25 @@ # 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 development. +twtxt registry written in Go! -* Began: 10 May 2019 -* No deadline. Should be finished by the end of May 2019. +* Easy to set up and maintain. +* Uses an in-memory cache to serve requests. +* Pushes to `LevelDB` at a configurable interval for data storage. +* Run directly facing the internet or behind `Caddy` / `nginx`. -## Progress +## Development Progress -The first blank box is what I'm working on. +`ETA` 31 May 2019 -* [x] Types and basic init/config -* [x] HTTP routing -* [x] Registry manipulation ([getwtxt/registry](https://github.com/getwtxt/registry)) -* [x] Request handling -* [x] Cache management details -* [x] Persistent data storage -* [ ] Refactor / Test -* [ ] Help flag / Documentation + +* [x] Types and Config +* [x] HTTP Routing +* [x] Registry Manipulation ([getwtxt/registry](https://github.com/getwtxt/registry)) +* [x] Request Handling +* [x] Cache Management +* [x] Persistent Data Storage +* [ ] Refactor / Test / Debug +* [ ] Documentation ## Notes |