From fb158f90f6ece8cd2d76251f361b6b3ad9a71da8 Mon Sep 17 00:00:00 2001 From: matty Date: Wed, 4 Mar 2026 04:18:58 +0000 Subject: [PATCH] de-troon the readme --- README.md | 32 ++++---------------------------- 1 file changed, 4 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index b3dd8ee9d..b43fd2801 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,16 @@ -# Nicolium +# NiceCrew Beta -[![Codeberg Repo stars](https://img.shields.io/gitea/stars/mkljczk/nicolium?gitea_url=https%3A%2F%2Fcodeberg.org&logo=Codeberg)](https://codeberg.org/mkljczk/nicolium) -[![GitHub Repo stars](https://img.shields.io/github/stars/mkljczk/nicolium)](https://github.com/mkljczk/nicolium) -[![GitHub License](https://img.shields.io/github/license/mkljczk/nicolium)](https://github.com/mkljczk/nicolium?tab=AGPL-3.0-1-ov-file#readme) -[![Weblate project translated](https://img.shields.io/weblate/progress/nicolium)](https://hosted.weblate.org/engage/nicolium/) +`ncd-fe` is a fork of [mkljczk's nicolium](https://codeberg.org/mkljczk/nicolium) and will be kept up to date with upstream as closely as possible, with one or more changes that pertain to the hot tub experience. This frontend will likely replace Soapbox after it is fleshed out, as it is maintained and actively developed with new features and bugfixes. # Repository The repository hosts ncd-fe, but also libraries related to the project. Currently, this includes: -- pl-fe itself — a social networking client app, modified for NiceCrew +- nicolium itself — a social networking client app, modified for NiceCrew - pl-api — a library for interacting with Mastodon API-compatible servers, focused on support for projects extending the official Mastodon API. It is used by ncd-fe. - pl-hooks — a library including hooks for integrating with Mastodon API, based on pl-api and TanStack Query. It is intended to be used within ncd-fe. Work in progress. -## Try it out - -Want to test Nicolium with **any existing MastoAPI-compatible server?** Try [web.nicolium.app](https://web.nicolium.app) — enter your server's domain name to use Nicolium on any server! - -If you want to use Nicolium on your server, follow the installation instructions in the documentation. We offer guides for [Pleroma/Akkoma](https://pl.mkljczk.pl/docs/installing/pleroma/), [Iceshrimp.NET](https://pl.mkljczk.pl/docs/installing/iceshrimp/), [Mitra](https://pl.mkljczk.pl/docs/installing/mitra/), and [standalone installations](https://pl.mkljczk.pl/docs/installing/standalone/). - -## Repository - -The repository hosts Nicolium, but also libraries related to the project. Currently, this includes: -- [Nicolium](./packages/nicolium/) itself — a social networking client app (formerly called pl-fe) -- [pl-api](./packages/pl-api) — a library for interacting with Mastodon API-compatible servers, focused on support for projects extending the official Mastodon API. It is used by Nicolium. -- [pl-hooks](./packages/pl-hooks) — a library including hooks for integrating with Mastodon API, based on `pl-api` and TanStack Query. It is intended to be used within Nicolium. Work in progress. - -## Contributing - -This project is hosted on [Codeberg](https://codeberg.org/mkljczk/nicolium) and [GitHub](https://github.com/mkljczk/nicolium). You can open issues on Codeberg or create pull requests on both platforms. - -You can find more information about setting up the development environment in [the documentation](https://pl.mkljczk.pl/docs/contributing/nicolium/). - -## License - -Nicolium is a fork of [Soapbox](https://gitlab.com/soapbox-pub/soapbox/) and inherits a lot of code from [Mastodon](https://github.com/mastodon/mastodon/). +# License AGPLv3+NIGGER This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by