Add a readme to make github happy

This commit is contained in:
Jason McBrayer 2018-01-05 21:32:26 -05:00
parent e48ac63cfe
commit a680493bb1

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# Brutaldon
Brutaldon is a [brutalist][0], [Web 1.0][0.5] web interface for [Mastodon][1]. It is not a Mastodon-compatible social networking server; rather, it is just a client, like the Android or iOS client for Mastodon you may already be using, but it runs in a web server, and is accessed through a web browser. The web browser that brutaldon targets is [Lynx][2]. Of course, you can use it in a more heavy-weight graphical browser, as well as other text browsers such as [w3m][3] or [elinks][4].
[0]:http://brutalistwebsites.com/
[0.5]: https://en.wikipedia.org/wiki/Web_2.0#%22Web_1.0%22
[1]: https://joinmastodon.org/
[2]: https://lynx.browser.org/
[3]: https://w3m.sourceforge.net/
[4]: http://elinks.or.cz/
Brutaldon is not ready for use yet. I literally haven't written it yet.
## Roadmap
* [ ] Single user read-only access; log in and read home timeline
* [ ] Multi-user support
* [ ] Add support for reading local and federated timelines, notifications, favorites.
* [ ] Add support for viewing profiles
* [ ] Add support for posting.
* [ ] Add support for posting media.
* [ ] Add support for favoriting and boosting toots.
* [ ] Add support for following, blocking, and muting users.
## Aesthetic
No automatic page updates: refresh the page to see new toots. No endless scroll: there's a "next page" link. No autocompletion of anything: use another lynx process in another screen window to look things up. UTF8 clean.