README
¶
getwtxt-ng
twtxt registry
twtxt is a decentralized microblogging platform
for hackers based on text files. The user is "followed" and "mentioned" by referencing
the URL to their twtxt.txt file and a nickname.
Registries are designed to aggregate several users' statuses into a single location, facilitating the discovery of new users to follow and allowing the search of statuses for tags and key words.
getwtxt-ng expands on the original registry specification by providing both plain and
JSON endpoints.
A reference instance can be found at twtxt.tilde.institute
2022-10-19: This has reached a "usable, but unpolished" state.
Notes
- twtxt Information:
twtxt.readthedocs.io - Registry Specification:
twtxt.readthedocs.io/en/latest/user/registry.html - getwtxt-ng uses
github.com/kevquirk/simple.cssfor the index and documentation web pages.
Contributing
All contributions are greatly appreciated!
A make target is included that will enable the pre-commit hook, install golangci-lint, and install govulncheck if you need it:
$ make dev-deps
If you already have golangci-lint and govulncheck installed, then be sure to use the pre-commit hook.
$ ln -s $(pwd)/pre-commit .git/hooks/pre-commit
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Package common implements utility functions shared between other packages.
|
Package common implements utility functions shared between other packages. |
|
Package registry implements a SQLite3 twtxt registry back-end.
|
Package registry implements a SQLite3 twtxt registry back-end. |