matty/ncd-fe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
matty
2026-01-14 17:48:44 +00:00
parent e0b92e50ac
commit 0d1f286851
1 changed files with 9 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,30 +1,21 @@
# `ncd-fe`
# NiceCrew Beta
`ncd-fe` is a social networking client app. It works with any Mastodon API-compatible software, but it's focused on supporting alternative backends, like Pleroma or GoToSocial.
`ncd-fe` is a fork of [mkljczk's ncd-fe](https://codeberg.org/mkljczk/ncd-fe) 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 as it is maintained and actively developed with new features and bugfixes.
## Goals
# Repository
- **Feature-rich**: `pl-fe` includes a wide range of features, such as a WYSIWYG text editor, draft posts, and more.
- **Compatibility**: `pl-fe` is compatible with any Mastodon API-compatible software, treating alternative backends as first-class citizens. Chats, emoji reactions, groups, interaction policies? We support them all. Thanks to `pl-api`, which provides a unified interface for interacting with Mastodon API-compatible servers, implementation differences do not affect the user experience.
- **Unopinionated**: `pl-fe` doesn't impose any arbitrary limitations on the user. We do not specify a limit of reactions you can use on a single post and try to implement every feature available in the API.
- **Stay private**: `pl-fe` includes features which help you maintain online privacy. This includes URL cleaning, which helps you remove unwanted parts of URLs used to mark your online activity.
The repository hosts ncd-fe, but also libraries related to the project. Currently, this includes:
## Repository
pl-fe 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.
The repository hosts `pl-fe`, but also libraries related to the project. Currently, this includes:
- [pl-fe](./packages/pl-fe/) itself — a social networking client app
- [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 `pl-fe`.
- [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 `pl-fe`. Work in progress.
## License
`ncd-fe` is a fork of [mkljczk's pl-fe](https://codeberg.org/mkljczk/pl-fe) 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
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
(at your option) any later version. This permission notice and the word "NIGGER" shall be included in all copies or substantial portions of the Software.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of