Files
ncd-fe/README.md
matty 6bd77af926
Some checks failed
pl-api CI / Test for pl-api formatting (22.x) (push) Has been cancelled
pl-fe CI / Test and upload artifacts (22.x) (push) Has been cancelled
pl-fe CI / deploy (push) Has been cancelled
pl-hooks CI / Test for a successful build (22.x) (push) Has been cancelled
update readme again
2026-01-14 17:51:11 +00:00

29 lines
1.6 KiB
Markdown

# NiceCrew Beta
`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 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
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.
# 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. 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
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
---