takahe/README.md

41 lines
1.6 KiB
Markdown
Raw Normal View History

2022-11-06 00:29:46 +00:00
![takahē](static/img/logo-128.png)
2022-11-05 20:22:36 +00:00
2022-12-24 18:27:45 +00:00
A *beta* Fediverse server for microblogging/"toots". Not fully functional yet -
2022-11-24 00:14:04 +00:00
we're still working towards a 1.0!
2022-11-05 20:22:36 +00:00
2022-12-30 19:13:06 +00:00
**Current version: [0.6.1](https://docs.jointakahe.org/en/latest/releases/0.6/)**
2022-11-27 21:09:16 +00:00
2022-11-24 00:14:04 +00:00
Key features:
2022-11-13 20:57:27 +00:00
2022-11-24 00:14:04 +00:00
- Multiple domain support
- Multiple identities per user (and can be shared between users)
- Desktop, mobile and PWA-compatible web UI (with minimal JavaScript)
2022-12-24 18:27:45 +00:00
- Mastodon-compatible client API (supports existing apps)
2022-11-24 00:14:04 +00:00
- Easy deployment (web worker, background worker, and one database)
2022-11-13 20:57:27 +00:00
2022-11-24 00:14:04 +00:00
For more background and information, see [jointakahe.org](https://jointakahe.org/).
2022-12-20 12:04:31 +00:00
<img width="570" alt="takahe-expanded" src="https://user-images.githubusercontent.com/36182/208662574-08b695ad-e97c-4288-bb5a-4c0e38b4517d.png"> <img width="306" alt="takahe-compact" src="https://user-images.githubusercontent.com/36182/208662601-dbbf303b-b836-4463-b2e6-4a872c7d50b2.png">
2022-11-24 00:14:04 +00:00
## Deployment
2022-11-27 21:04:43 +00:00
See [our deployment documentation](https://docs.jointakahe.org/en/latest/installation/).
For changelog and update notes, visit [our releases documentation](https://docs.jointakahe.org/en/latest/releases/).
2022-11-24 00:14:04 +00:00
## Roadmap
2022-11-24 00:14:04 +00:00
Takahē is still under very active development towards a 1.0 release, and not
all functionality is supported yet.
2022-11-27 21:04:43 +00:00
For a detailed feature breakdown, see [the features page in our docs](https://docs.jointakahe.org/en/latest/features/).
2022-12-05 21:24:10 +00:00
For an idea of what features are currently in flight, see [our project board for the next release](https://github.com/orgs/jointakahe/projects/1/views/1).
2022-11-13 20:57:27 +00:00
## Contributing
2022-11-27 21:04:43 +00:00
If you'd like to contribute, please read [our contributing docs](https://docs.jointakahe.org/en/latest/contributing/).