summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvsl-iil <36484938+vsl-iil@users.noreply.github.com>2023-08-26 19:35:36 +0000
committerGitHub <noreply@github.com>2023-08-26 19:35:36 +0000
commita41b443d30c51b07ed9f092e36e694dc445a0858 (patch)
tree02a2161ec3edb51216ff4aecf99eb73baae8d242
parent32116608964af22b3143a1044bb152a2af853d64 (diff)
Added the installation instructions
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index d22b7bd..719b7a4 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,10 @@ Allows you to set share limits for users. If they share less, they will be banne
You can set messages that will be sent to users.
The original author expressed no intent in supporting the code; thus, I release it under CC0 and will try to develop the plugin and fix bugs.
+
+## Installation
+
+1. In Nicotine+, go to Settings -> Plugins, press 'Add';
+2. Clone this repo into the opened folder, or manually copy `__init__.py` and `PLUGININFO` from the repo to a new folder inside the opened one;
+3. Check the boxes 'Enable plugins' and 'Autobahn' in Nicotine+ plugins settings menu;
+4. Select 'Autobahn', press 'Settings' and set the limits and messages.