Update README
This commit is contained in:
parent
b16144f274
commit
3633c954a9
1 changed files with 13 additions and 10 deletions
23
README.md
23
README.md
|
@ -2,9 +2,12 @@
|
||||||
|
|
||||||
> Cross-instance share page for Mastodon
|
> Cross-instance share page for Mastodon
|
||||||
|
|
||||||
[toot] allows you to share stuff on Mastodon, cross-instance. Just put in your post text and the instance URL and click ‘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. The same goes for the `instance` URL parameter. This can be used to build custom share buttons for Mastodon:
|
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:
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<a href="https://toot.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz">
|
<a href="https://toot.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz">
|
||||||
|
@ -12,7 +15,8 @@ And if you open this page with `text` URL parameter, it will be auto-inserted in
|
||||||
</a>
|
</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!
|
||||||
|
|
||||||
## Hosting
|
## Hosting
|
||||||
|
|
||||||
|
@ -47,11 +51,13 @@ Self-hosting toot outside of Vercel requires some extra setup:
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
**[📯 shareon](https://shareon.js.org)** — lightweight, stylish and ethical share buttons — use [toot] under the hood!
|
**[📯 Shareon](https://shareon.js.org)**
|
||||||
|
(lightweight, stylish, and ethical share buttons) uses [toot] under the hood!
|
||||||
|
|
||||||
## Licence
|
## Licence
|
||||||
|
|
||||||
[AGPL-3.0](https://spdx.org/licenses/AGPL-3.0-only.html) © 2020-2021, Nikita Karamov
|
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)
|
||||||
|
|
||||||
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 ‘toot’ logo is based on Mastodon’s ‘Simple’ logo, licensed under [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html).
|
||||||
|
|
||||||
|
@ -59,9 +65,6 @@ The repo banner includes Mastodon’s ‘Full’ logo, licensed under [AGPL-3.0]
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
The source code is being hosted
|
This project is hosted on Codeberg: <https://codeberg.org/kytta/toot>
|
||||||
on [GitHub](https://github.com/kytta/toot), with mirrors
|
|
||||||
on [GitLab](https://gitlab.com/kytta/toot)
|
|
||||||
and [Codeberg](https://codeberg.org/kytta/toot).
|
|
||||||
|
|
||||||
[toot]: https://toot.kytta.dev
|
[toot]: https://toot.kytta.dev/
|
||||||
|
|
Reference in a new issue