From 7b3cdaea0c6c682eff07692c76c93d58a3313189 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?nicole=20miko=C5=82ajczyk?= Date: Mon, 5 Jan 2026 19:54:52 +0100 Subject: [PATCH] Update README after documentation changes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nicole mikołajczyk --- README.md | 20 +++----------------- docs/{building.md => building/pl-fe.md} | 0 docs/installing/standalone.md | 2 +- 3 files changed, 4 insertions(+), 18 deletions(-) rename docs/{building.md => building/pl-fe.md} (100%) diff --git a/README.md b/README.md index 85c499ceb..04eb37810 100644 --- a/README.md +++ b/README.md @@ -19,35 +19,21 @@ Want to test `pl-fe` with **any existing MastoAPI-compatible server?** Try [pl.mkljczk.pl](https://pl.mkljczk.pl) — enter your server's domain name to use `pl-fe` on any server! -If you want to use `pl-fe` as the default frontend on your server, download the latest build from [pl.mkljczk.pl/pl-fe.zip](http://pl.mkljczk.pl/pl-fe.zip) and install it following the instructions for your backend. For example, on a standard Pleroma installation you can use: - -```sh -curl -O https://pl.mkljczk.pl/pl-fe.zip -unzip pl-fe.zip -d /opt/pleroma/instance/static/ -rm pl-fe.zip -``` +If you want to use `pl-fe` 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 `pl-fe`, but also libraries related to the project. This includes: +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. -More projects to be announced. - ## Contributing This project is hosted on [Codeberg](https://codeberg.org/mkljczk/pl-fe) and [GitHub](https://github.com/mkljczk/pl-fe). You can open issues on Codeberg or create pull requests on both platforms. -Code contributions are welcome. I will provide contributing guidelines after I decide whether the current monorepo model is the correct approach. - -[Weblate](https://hosted.weblate.org/projects/pl-fe/) is used for project translation. - - -Translation status - +You can find more information about setting up the development environment in [the documentation](https://pl.mkljczk.pl/docs/contributing/pl-fe/). ## FAQ / Common misconceptions diff --git a/docs/building.md b/docs/building/pl-fe.md similarity index 100% rename from docs/building.md rename to docs/building/pl-fe.md diff --git a/docs/installing/standalone.md b/docs/installing/standalone.md index 515063df9..70e8c7035 100644 --- a/docs/installing/standalone.md +++ b/docs/installing/standalone.md @@ -13,4 +13,4 @@ pl-fe.example.com { } ``` -This assumes you're serving `pl-fe` under the pl-fe.example.com domain and the `pl-fe` files are located in `/var/www/pl-fe`. You can download `pl-fe` from `https://pl.mkljczk.pl/pl-fe.zip` or [build it from source](../building.md). \ No newline at end of file +This assumes you're serving `pl-fe` under the pl-fe.example.com domain and the `pl-fe` files are located in `/var/www/pl-fe`. You can download `pl-fe` from `https://pl.mkljczk.pl/pl-fe.zip` or [build it from source](../building/pl-fe.md). \ No newline at end of file