update README

This commit is contained in:
n 2024-01-27 18:28:53 +01:00
parent 9c9372c7d0
commit 6f2b6727de
Signed by: n
GPG key ID: 510227DD6C502CE3

View file

@ -1,9 +1,12 @@
# ShaarGem
[Shaarli](https://github.com/shaarli/Shaarli/) plugin for Gemini capsules shaaring.
[Shaarli](https://github.com/shaarli/Shaarli/) plugin for [Gemini](https://geminiprotocol.net/) capsules shaaring.
## Manual
1. Clone repository in plugin directory.
1. Clone repository in `plugins` directory (plugin directory name must be `shaargem`)
```
$ git clone https://forge.tourmentine.com/n/shaarli-plugin-shaargem.git path/to/shaarli/plugins/shaargem
```
2. Activate plugin.
3. Share a gemini:// IRI.
3. Share a `gemini://` IRI.