From 94704c8f59b6f064daa7e2f6f3701dedc45193c8 Mon Sep 17 00:00:00 2001 From: Nikita Karamov Date: Mon, 14 Nov 2022 13:39:51 +0100 Subject: [PATCH] Update README --- README.md | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 09cb35d..295c351 100644 --- a/README.md +++ b/README.md @@ -2,35 +2,31 @@ > Instance-agnostic share page for the Fediverse. -[toot] allows you to share stuff on Mastodon, cross-instance. Just put in your -post text and the instance URL and click ‘Toot!’ +**[Share₂Fedi]** allows you to share stuff on Mastodon, GoToSocial, Pleroma, and other federated social networks, instance-agnostic. Just type in the post text and the instance URL, and click ‘Post!’ -And if you open this page with `text` URL parameter, it will be auto-inserted -in the text field. The same goes for the `instance` URL parameter. This can be -used to build custom share buttons for Mastodon: +Or, open this page with the prefilled `text` URL parameter—it will be automatically inserted into the text field. The same goes for the `instance` URL parameter. This can be used to build custom share buttons for the federated social networks: ```html - - Share on Mastodon + + Share on mastodon.xyz ``` -The instance URL can be saved in your `localStorage` to be automatically -appended later — handy! +The instance URL can be saved in your `localStorage` to be automatically appended if used later—handy! ## Hosting ### One-click Vercel deploy -For now, toot is a tad bit vendor-locked to run on -[Vercel](https://vercel.com/). To deploy it yourself, you can use the following -button: +For now, **Share₂Fedi** is vendor-locked to run on [Vercel](https://vercel.com/). To deploy it yourself, you can use the following button: [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fkytta%2Ftoot) + + ## See also **[📯 Shareon](https://shareon.js.org)** -(lightweight, stylish, and ethical share buttons) uses [toot] under the hood! +(lightweight, stylish, and ethical share buttons) uses **Share₂Fedi** under the hood! ## Licence -Copyright © 2020–2022 [Nikita Karamov](https://www.kytta.dev/) -Licenced under the [GNU Affero General Public License, version 3](https://spdx.org/licenses/AGPL-3.0-only.html) +© 2020–2022 [Nikita Karamov]\ +Licensed under the [GNU Affero General Public License, version 3][AGPL-3.0]. -The ‘toot’ logo is based on Mastodon’s ‘Simple’ logo, licensed under [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html). - -The repo banner includes Mastodon’s ‘Full’ logo, licensed under [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html). +The repo banner includes Mastodon’s ‘Full’ logo, licensed under [AGPL-3.0]. --- -This project is hosted on Codeberg: +This project is hosted on Codeberg: -[toot]: https://toot.kytta.dev/ +[AGPL-3.0]: https://spdx.org/licenses/AGPL-3.0-only.html +[Nikita Karamov]: https://www.kytta.dev +[Share₂Fedi]: https://s2f.kytta.dev/