mirror of
https://github.com/versia-pub/server.git
synced 2025-12-06 08:28:19 +01:00
Update README.md
Adds info about why I havent been contributing to this project
This commit is contained in:
parent
96dea34f9a
commit
a9fb39f764
16
README.md
16
README.md
|
|
@ -4,6 +4,8 @@
|
||||||
|
|
||||||
       [](code_of_conduct.md)
|
       [](code_of_conduct.md)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> This project is **not abandoned**, my laptop merely broke and I am waiting for a new one to arrive
|
||||||
|
|
||||||
## What is this?
|
## What is this?
|
||||||
|
|
||||||
|
|
@ -11,7 +13,8 @@ This is a project to create a federated social network based on the [Lysand](htt
|
||||||
|
|
||||||
This project aims to be a fully featured social network, with a focus on privacy, security, and performance. It will implement the Mastodon API for support with clients that already support Mastodon or Pleroma.
|
This project aims to be a fully featured social network, with a focus on privacy, security, and performance. It will implement the Mastodon API for support with clients that already support Mastodon or Pleroma.
|
||||||
|
|
||||||
> **Note:** This project is not affiliated with Mastodon or Pleroma, and is not a fork of either project. It is a new project built from the ground up.
|
> [!NOTE]
|
||||||
|
> This project is not affiliated with Mastodon or Pleroma, and is not a fork of either project. It is a new project built from the ground up.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|
@ -31,7 +34,8 @@ This project aims to be a fully featured social network, with a focus on privacy
|
||||||
|
|
||||||
## Benchmarks
|
## Benchmarks
|
||||||
|
|
||||||
> **Note**: These benchmarks are not representative of real-world performance, and are only meant to be used as a rough guide.
|
> [!NOTE]
|
||||||
|
> These benchmarks are not representative of real-world performance, and are only meant to be used as a rough guide.
|
||||||
|
|
||||||
### Timeline Benchmarks
|
### Timeline Benchmarks
|
||||||
|
|
||||||
|
|
@ -174,7 +178,8 @@ The `bun prisma` commands allows you to use Prisma commands without needing to a
|
||||||
|
|
||||||
## With Docker
|
## With Docker
|
||||||
|
|
||||||
> **Note**: Docker is currently broken, as Bun with Prisma does not work well with Docker yet for unknown reasons. The following instructions are for when this is fixed.
|
> [!NOTE]
|
||||||
|
> Docker is currently broken, as Bun with Prisma does not work well with Docker yet for unknown reasons. The following instructions are for when this is fixed.
|
||||||
>
|
>
|
||||||
> These instructions will probably also work with Podman and other container runtimes.
|
> These instructions will probably also work with Podman and other container runtimes.
|
||||||
|
|
||||||
|
|
@ -221,7 +226,8 @@ Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) fil
|
||||||
|
|
||||||
## Federation
|
## Federation
|
||||||
|
|
||||||
> **Warning**: Federation has not been tested outside of automated tests. It is not recommended to use this software in production.
|
> [!WARNING]
|
||||||
|
> Federation has not been tested outside of automated tests. It is not recommended to use this software in production.
|
||||||
|
|
||||||
The following extensions are currently supported or being worked on:
|
The following extensions are currently supported or being worked on:
|
||||||
- `org.lysand:custom_emojis`: Custom emojis
|
- `org.lysand:custom_emojis`: Custom emojis
|
||||||
|
|
@ -352,4 +358,4 @@ WebSocket Streaming API also needed to be added (and push notifications)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the [AGPL-3.0](LICENSE).
|
This project is licensed under the [AGPL-3.0](LICENSE).
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue