diff --git a/README.md b/README.md index 3f4c9fb..6505406 100644 --- a/README.md +++ b/README.md @@ -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.