Update README

* fix typographical errors
* replace licence link with SPDX
This commit is contained in:
Nikita Karamov 2021-05-13 14:24:32 +02:00
parent 83c05f647a
commit f0afff0f2a
No known key found for this signature in database
GPG key ID: EA4E7DECEEA050E4

View file

@ -2,28 +2,28 @@
> Cross-instance share page 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!"
[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:
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
<a href="https://toot.karamoff.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz">
Share on Mastodon
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
## Licence
[AGPL-3.0](./LICENSE) © 2020-2021 [Nikita Karamov](nick@karamoff.dev)
[AGPL-3.0](https://spdx.org/licenses/AGPL-3.0-only.html) © 2020-2021, Nikita Karamov
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 Mastodons 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 Mastodons Full logo, licensed under [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html).
[toot]: https://toot.karamoff.dev