summary refs log tree commit diff stats
path: root/README.md
blob: 61277a08c6100ff25966bab889131a57f960b937 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# getwtxt [![Build Status](https://travis-ci.com/getwtxt/getwtxt.svg?branch=master)](https://travis-ci.com/getwtxt/getwtxt)

twtxt registry written in Go! 

* 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`.

A public instance is currently available:
* [twtxt.tilde.institute](https://twtxt.tilde.institute)

## Development Progress

`ETA` 07 June 2019


* [x] Types and Config
* [x] HTTP Routing
* [x] Registry Manipulation ([getwtxt/registry](https://github.com/getwtxt/registry))
* [x] Request Handling
* [x] Database and Caching
* [ ] Refactor / Test / Debug
* [ ] Documentation

## Notes

* twtxt
  * [twtxt.readthedocs.io](https://twtxt.readthedocs.io)