2023-02-04 23:00:34 +01:00
|
|
|
<div align="center"><img src="./logo.svg" height="200" alt="Foundkey logo, an owl holding a key"/></div>
|
2023-02-04 22:15:28 +01:00
|
|
|
|
2022-08-31 19:25:39 -04:00
|
|
|
# FoundKey
|
2023-07-10 17:46:57 +02: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-23 23:10:00 -07:00
|
|
|
|
2022-08-31 19:25:39 -04:00
|
|
|
See the [changelog](./CHANGELOG.md) and [roadmap](./ROADMAP.md) for more on what's changed and future plans.
|
2018-04-16 05:04:56 +09:00
|
|
|
|
2022-05-27 23:21:12 +02:00
|
|
|
## Documentation
|
2023-03-03 23:46:45 +01:00
|
|
|
FoundKey's documentation is a work in progress, which can be found in the `docs/` folder.
|
2023-07-10 17:46:57 +02:00
|
|
|
Feel free to contribute some documentation.
|
2022-05-27 23:21:12 +02:00
|
|
|
|
2022-08-31 19:25:39 -04:00
|
|
|
## Contributing
|
|
|
|
|
If you're interested in helping out with the project, please read the [contributing guide](./CONTRIBUTING.md).
|
2022-05-27 23:21:12 +02:00
|
|
|
|
2021-11-20 18:21:18 +09:00
|
|
|
## Sponsors
|
2023-02-04 23:00:34 +01: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).
|
