FoundKey/README.md
Johann150 415e84daf0
Some checks failed
ci/woodpecker/push/lint-foundkey-js Pipeline was successful
ci/woodpecker/push/lint-client Pipeline failed
ci/woodpecker/push/lint-backend Pipeline failed
ci/woodpecker/push/build Pipeline was successful
ci/woodpecker/push/lint-sw Pipeline failed
ci/woodpecker/push/test Pipeline failed
updated maintenance status
2023-07-10 17:46:57 +02:00

21 lines
1 KiB
Markdown

<div align="center"><img src="./logo.svg" height="200" alt="Foundkey logo, an owl holding a key"/></div>
# FoundKey
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.
See the [changelog](./CHANGELOG.md) and [roadmap](./ROADMAP.md) for more on what's changed and future plans.
## Documentation
FoundKey's documentation is a work in progress, which can be found in the `docs/` folder.
Feel free to contribute some documentation.
## Contributing
If you're interested in helping out with the project, please read the [contributing guide](./CONTRIBUTING.md).
## Sponsors
FoundKey is not interested in finanical sponsorships.
We welcome contributions in the forms of code, testing and bug reporting (see also section *Contributing* above).