diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c8422394..a30b6db58 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,13 +11,9 @@ Please understand that in such cases we might edit your issue to translate it, t ## Development platform FoundKey generally assumes that it is running on a Unix-like platform (e.g. Linux or macOS). If you are using Windows for development, we highly suggest using the Windows Subsystem for Linux (WSL) as the development environment. -## Roadmap -See [ROADMAP.md](./ROADMAP.md) - ## Issues Issues are intended for feature requests and bug tracking. - -For technical support or if you are not sure if what you are experiencing is a bug you can talk to people on the [IRC server](https://irc.akkoma.dev) in the `#foundkey` channel first. +Please note that in general, we are not looking for completely new features to add, but quality of life improvements will be considered. Please do not close issues that are about to be resolved. It should remain open until a commit that actually resolves it is merged. diff --git a/README.md b/README.md index 68f629c74..bd633eaae 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@
Foundkey logo, an owl holding a key
# FoundKey -FoundKey is a free and open source microblogging server compatible with ActivityPub. Forked from Misskey, FoundKey improves on maintainability and behaviour, while also bringing in useful features. +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. - -In the meantime, much of the documentation on the [Misskey Hub](https://misskey-hub.net/) will also apply to FoundKey. +Feel free to contribute some documentation. ## Contributing If you're interested in helping out with the project, please read the [contributing guide](./CONTRIBUTING.md).