about summary refs log blame commit diff stats
path: root/README.md
blob: b8598193a053b0f2bf6e48d144372b62f7c966d9 (plain) (tree)
1
2
3
4
5
6
7
8
9
                                                                                                                           
 
                              
 



                                                                   
 


                                                        
                       
 
                  
 




                                                                                     
                          
                             
                   




                                                        
# 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` 01 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
* [x] Refactor / Test / Debug
* [ ] Documentation

## Notes

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