From 6e95ea7840a31ecb95007ae382ac7d7429704600 Mon Sep 17 00:00:00 2001 From: Drazzilb <65743746+Drazzilb08@users.noreply.github.com> Date: Wed, 24 Nov 2021 06:51:27 -0800 Subject: [PATCH] Updates to home and Installation --- .gitignore | 2 ++ Home.md | 23 +++++++++++++++++++++-- Installation.md | 2 ++ 3 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9bea433 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ + +.DS_Store diff --git a/Home.md b/Home.md index 6c68a4b..77cc453 100644 --- a/Home.md +++ b/Home.md @@ -1,5 +1,24 @@ -# Getting Started -Install qbit_mange either by installing Python3 on the localhost and following the [Local Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Local-Installations) Guide or by installing Docker and following the [Docker Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Docker-Installation) Guide or the [unRAID Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Unraid-Installation) Guide.
+# qBit_manage Wiki +This wiki should tell you everything you need to know about the script to get it working. + +## Getting Started +1. Install qbit_mange either by installing Python3 on the localhost and following the [Local Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Local-Installations) Guide or by installing Docker and following the [Docker Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Docker-Installation) Guide or the [unRAID Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Unraid-Installation) Guide.
Once installed, you have to edit the config file.
After that, you can start automatically managing your qBittorrent instance. +2. Once installed, you have to create a [Configuration File](https://github.com/StuffAnThings/qbit_manage/blob/master/config/config.yml.sample) filled with all your values to connect to your qBittorrent instance. + +## Support +* If you're getting an Error or have an Enhancement post in the [Issues](https://github.com/StuffAnThings/qbit_manage/issues/new). +* If you have a configuration question post in the [Discussions](https://github.com/StuffAnThings/qbit_manage/discussions/new). +* Pull Request are welcome but please submit them to the [develop branch](https://github.com/StuffAnThings/qbit_manage/tree/develop). + + +## Table of Contents +- [Home](https://github.com/StuffAnThings/qbit_manage/wiki) + - [Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Installation) + - [unRAID Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Unraid-Installation) + - [Local Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Local-Installations) + - [NIX Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Nix-Installation) + - [Docker Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Docker-Installation) + - [Config Setup](https://github.com/StuffAnThings/qbit_manage/wiki/Config-Setup) \ No newline at end of file diff --git a/Installation.md b/Installation.md index 02b0f59..55b178f 100644 --- a/Installation.md +++ b/Installation.md @@ -1,3 +1,5 @@ +# Installation Table of Contents + - [Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Installation) - [unRAID Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Unraid-Installation) - [Local Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Local-Installations)