Added usage doc

This commit is contained in:
Neocky 2021-03-08 03:13:31 +01:00 committed by GitHub
parent 4c5e3b9235
commit ee6d24a3a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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'
```