MinPluto/share2fedi
Archived
1
Fork 0
Code Issues Pull requests Activity

Update README

Browse source
This commit is contained in:
Nikita Karamov 2022-11-14 13:39:51 +01:00
parent f33c58bb91
commit 94704c8f59
No known key found for this signature in database
GPG key ID: 41D6F71EE78E77CD
1 changed files with 18 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -2,35 +2,31 @@
> Instance-agnostic share page for the Fediverse. > Instance-agnostic share page for the Fediverse.
[toot] allows you to share stuff on Mastodon, cross-instance. Just put in your **[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!’
post text and the instance URL and click ‘Toot!’
And if you open this page with `text` URL parameter, it will be auto-inserted 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:
in the text field. The same goes for the `instance` URL parameter. This can be
used to build custom share buttons for Mastodon:
```html ```html
<a href="https://toot.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz"> <a href="https://s2f.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz">
Share on Mastodon Share on mastodon.xyz
</a> </a>
``` ```
The instance URL can be saved in your `localStorage` to be automatically The instance URL can be saved in your `localStorage` to be automatically appended if used later—handy!
appended later — handy!
## Hosting ## Hosting
### One-click Vercel deploy ### One-click Vercel deploy
For now, toot is a tad bit vendor-locked to run on For now, **Share₂Fedi** is vendor-locked to run on [Vercel](https://vercel.com/). To deploy it yourself, you can use the following button:
[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) [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fkytta%2Ftoot)
<!-- TODO: update the selfhosting instructions -->
<!--
### Host it yourself ### Host it yourself
Self-hosting toot outside of Vercel requires some extra setup: Self-hosting **Share₂Fedi** outside of Vercel requires some extra setup:
1. Make sure you have got Node.js v12 or later as well as pnpm installed 1. Make sure you have got Node.js v12 or later as well as pnpm installed
@ -86,23 +82,24 @@ Self-hosting toot outside of Vercel requires some extra setup:
reverse_proxy localhost:8000 reverse_proxy localhost:8000
} }
``` ```
-->
## See also ## See also
**[📯 Shareon](https://shareon.js.org)** **[📯 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 ## Licence
Copyright © 2020–2022 [Nikita Karamov](https://www.kytta.dev/) © 2020–2022 [Nikita Karamov]\
Licenced under the [GNU Affero General Public License, version 3](https://spdx.org/licenses/AGPL-3.0-only.html) 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].
The repo banner includes Mastodon’s ‘Full’ logo, licensed under [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html).
--- ---
This project is hosted on Codeberg: <https://codeberg.org/kytta/toot> This project is hosted on Codeberg: <https://codeberg.org/kytta/toot.git>
[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/