bigbuffet-rw/packages/pl-fe/README.md
marcin mikołajczak 2ff3b88d3a pl-fe: Update README.md
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
2024-09-06 21:29:08 +02:00

3.2 KiB

pl-fe is a social networking client app forked from Soapbox. It is intended to be used with pl backend, but works with any Mastodon API-compatible software.

Differences compared to Soapbox

  • Broader compatibility: The compatibility matrix has been updated to support more features on various backends. Support for features specific to Mitra, Toki, GoToSocial and Akkoma has been added, more are coming soon.
  • WYSIWYG status composer: You can use the WYSIWYG editor for advanced text formatting on any backend with Markdown support.
  • Language detection: When you write a post, the language gets detected automatically with great accuracy. You can always select it manually.
  • Drafts: You can save a post you are working on and finish it later. Drafts are only stored locally and work with any backend.
  • Quote anywhere: If your backend supports quote posts, you can now quote a post by simply putting the link in your post, so you can now quote other posts in a reply.
  • Interaction circles: A fun feature you might know from third-party tools for Twitter. You can generate a picture that represents the accounts you interact the most with.

There is more to mention. pl-fe includes various minor improvements and visual changes.

Try it out

Want to test pl-fe with any existing MastoAPI-compatible server? Try 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 and install it following the instructions for your backend. For example, on a standard Pleroma installation you can use:

curl -O http://pl.mkljczk.pl/pl-fe.zip
unzip pl-fe.zip -d /opt/pleroma/instance/static/
rm pl-fe.zip

Contribute

Code contributions are welcome. Weblate is used for project translation.

Translation status

License

pl-fe is a fork of Soapbox, which was forked from Gab Social, which is a fork of Mastodon.

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 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/.


Follow my Pleroma account to stay up to date on pl-fe development. You can also join the project community on Discord.