From ee6d24a3a25aea34907940c99bca0c75e068f604 Mon Sep 17 00:00:00 2001 From: Neocky Date: Mon, 8 Mar 2021 03:13:31 +0100 Subject: [PATCH] Added usage doc --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93ebb62..8e18751 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,37 @@ Python needs to be installed on your machine. Get it [here](https://www.python.org/downloads/). ### Needed packages Install the needed packages for this project. -Execute this command in the /plugGET folder: +Execute this command in the ```/plugGET``` folder: ```python pip install -r requirements.txt ``` + +## Usage +Run programm. +The following are examples for the general usage: +(Hint: 'all' can always be exchanged through the plugin name or the plugin id and reverse) +#### Download latest update of specific package: +``` +get 'pluginName' +``` +or: +``` +get 'pluginID' +``` +#### Check all installed plugins for updates: +``` +check all +``` +#### Check one plugin for updates: +``` +check 'pluginName' +``` +#### Update all installed plugins: +``` +update all +``` +#### Update only one plugin: +``` +update 'pluginName' +``` +