FoundKey/README.md

22 lines
1 KiB
Markdown
Raw Normal View History

2023-02-04 22:00:34 +00:00
<div align="center"><img src="./logo.svg" height="200" alt="Foundkey logo, an owl holding a key"/></div>
2023-02-04 21:15:28 +00:00
2022-08-31 23:25:39 +00:00
# FoundKey
2023-07-10 15:46:57 +00:00
FoundKey is a free and open source microblogging server compatible with ActivityPub.
It is currently under **LIMITED MAINTENANCE** and is not well suited for large instances.
No more than 20 users per instance are recommended.
Forked from Misskey, FoundKey improves on maintainability and behaviour, while also bringing in useful features.
2022-05-24 06:10:00 +00:00
2022-08-31 23:25:39 +00:00
See the [changelog](./CHANGELOG.md) and [roadmap](./ROADMAP.md) for more on what's changed and future plans.
2018-04-15 20:04:56 +00:00
## Documentation
2023-03-03 22:46:45 +00:00
FoundKey's documentation is a work in progress, which can be found in the `docs/` folder.
2023-07-10 15:46:57 +00:00
Feel free to contribute some documentation.
2022-08-31 23:25:39 +00:00
## Contributing
If you're interested in helping out with the project, please read the [contributing guide](./CONTRIBUTING.md).
2021-11-20 09:21:18 +00:00
## Sponsors
2023-02-04 22:00:34 +00:00
FoundKey is not interested in finanical sponsorships.
We welcome contributions in the forms of code, testing and bug reporting (see also section *Contributing* above).