Update README.md
This commit is contained in:
parent
d9c409cc3e
commit
55257324f4
1 changed files with 10 additions and 12 deletions
22
README.md
22
README.md
|
@ -1,20 +1,22 @@
|
|||
<h1 align="center"><img src="assets/logo.svg" width="128" height="128" alt="toot"></h1>
|
||||
|
||||
[`toot`][toot] is a share page for Mastodon, allowing you to share stuff cross-instance.
|
||||
Just put in your post text and the instance URL and click "Toot!"
|
||||
> Cross-instance share page for Mastodon
|
||||
|
||||
And if you open this page with `text` URL parameter, it will be auto-inserted in the
|
||||
text field. Same goes for the `instance` URL parameter. This can be used to build
|
||||
custom share buttons for Mastodon:
|
||||
[`toot`][toot] allows you to share stuff on Mastodon, cross-instance. Just put in your post text and the instance URL and click "Toot!"
|
||||
|
||||
And if you open this page with `text` URL parameter, it will be auto-inserted in the text field. Same goes for the `instance` URL parameter. This can be used to build custom share buttons for Mastodon:
|
||||
|
||||
```html
|
||||
<a href="https://toot.karamoff.dev/?text=Hello%20world&instance=https%3A%2F%2Fmastodon.xyz">
|
||||
<a href="https://toot.karamoff.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz">
|
||||
Share on Mastodon
|
||||
</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 later — handy!
|
||||
|
||||
## See also
|
||||
|
||||
**[📯 shareon](https://shareon.js.org)** — lightweight, stylish and ethical share buttons — use [toot] under the hood!
|
||||
|
||||
## License
|
||||
|
||||
|
@ -24,8 +26,4 @@ The `toot` logo is based on Mastodon's "Simple" 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).
|
||||
|
||||
----
|
||||
|
||||
[![Powered by Vercel](https://badgen.net/badge/powered%20by/vercel/black)](https://vercel.com)
|
||||
|
||||
[toot]: https://toot.karamoff.dev
|
||||
|
|
Reference in a new issue