Update README
This commit is contained in:
parent
f33c58bb91
commit
94704c8f59
1 changed files with 18 additions and 21 deletions
39
README.md
39
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
|
||||
<a href="https://toot.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz">
|
||||
Share on Mastodon
|
||||
<a href="https://s2f.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz">
|
||||
Share on mastodon.xyz
|
||||
</a>
|
||||
```
|
||||
|
||||
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)
|
||||
|
||||
<!-- TODO: update the selfhosting instructions -->
|
||||
<!--
|
||||
### 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
|
||||
|
||||
|
@ -86,23 +82,24 @@ Self-hosting toot outside of Vercel requires some extra setup:
|
|||
reverse_proxy localhost:8000
|
||||
}
|
||||
```
|
||||
-->
|
||||
|
||||
## 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: <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/
|
||||
|
|
Reference in a new issue