From 81e7581ff518c4a0b79eda656b7c90106a6dcb22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?marcin=20miko=C5=82ajczak?= Date: Sat, 31 Aug 2024 15:49:16 +0200 Subject: [PATCH] update readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: marcin mikołajczak --- README.md | 8 ++++++++ packages/pl-fe/README.md | 8 ++++++++ 2 files changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..8a4a97d53 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +This repo hosts a few of my projects related to the Fediverse client `pl-fe`. This includes: + +- [pl-fe](./packages/pl-fe/) — a social networking client app forked from Soapbox +- [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`. + +More projects to be announced. + +Follow [my Pleroma account](https://pl.fediverse.pl/@mkljczk) to stay up to date on `pl-fe` development. \ No newline at end of file diff --git a/packages/pl-fe/README.md b/packages/pl-fe/README.md index 9697ef6d8..706972f8a 100644 --- a/packages/pl-fe/README.md +++ b/packages/pl-fe/README.md @@ -15,6 +15,14 @@ There is more to mention. `pl-fe` includes various minor improvements and visual 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 http://pl.mkljczk.pl/pl-fe.zip +unzip pl-fe.zip -d /opt/pleroma/instance/static/ +rm pl-fe.zip +``` + ## License `pl-fe` is a fork of Soapbox, which was forked from [Gab Social](https://github.com/GabOpenSource/gab-social), which is a fork of [Mastodon](https://github.com/mastodon/mastodon/).