readme

.github/workflows/prod-deploy copy.yml

@@ -7,17 +7,17 @@ jobs:
   github-release-production:
     runs-on: ubuntu-latest
     steps:
-        - uses: actions/checkout@master
-        - uses: actions/setup-node@master
-        - run: npm install
-        - run: npm run build
-        - uses: montudor/action-zip@v0.1.0
-          with:
-            args: zip -qq -r ./release.zip ./vuetorrent
-        - uses: "marvinpinto/action-automatic-releases@latest"
-          with:
-            repo_token: "${{ secrets.GITHUB_TOKEN }}"
-            automatic_release_tag: "latest"
-            prerelease: true
-            title: "Stable Build"
-            files: release.zip
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@master
+      - run: npm install
+      - run: npm run build
+      - uses: montudor/action-zip@v0.1.0
+        with:
+          args: zip -qq -r ./release.zip ./vuetorrent
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: "latest"
+          prerelease: true
+          title: "Stable Build"
+          files: release.zip

README.md

@@ -1,24 +1,71 @@
-# vuetorrent
+# VueTorrent
 
-## Project setup
-```
-npm install
-```
+The sleekest looking WEBUI for qBittorrent made with Vuejs!
 
-### Compiles and hot-reloads for development
-```
-npm run serve
-```
+> Vue, qBitorrent, Vuetify
 
-### Compiles and minifies for production
-```
-npm run build
-```
+## Screenshots
 
-### Lints and fixes files
-```
-npm run lint
-```
+<p  align="center">
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+<a  href="https://i.imgur.com/vPBcrK4.png"><img  src="https://i.imgur.com/vPBcrK4.png"  title="Desktop"  alt="Desktop Screenshot" ></a>
+
+</p>
+
+<p  align="center">
+
+<a  href="https://i.imgur.com/SUOEyy9.png"><img  src="https://i.imgur.com/SUOEyy9.png"  title="Mobile"  alt="Mobile Screenshot"  width="320"  height="540"></a>
+
+</p>
+
+## Installation
+
+-   Download & Unzip the latest release
+
+-   Point your Alternate WEBUI location to it
+
+## Development
+
+-   clone the repo
+
+-   npm install
+
+-   npm run serve
+
+## Features
+
+-   viewing sessions stats ( down / upload speed, session uploaded / downloaded )
+-   adding / removing / pausing / resuming torrents
+
+-   sorting by every property shown!
+
+*   mobile friendly! (maybe not for thousands of torrents...)
+
+-   works on QBittorrent V4.2 and later
+
+## Contributing
+
+I'll gladly accept help/pull requests & advice! (this is my first project of this nature, pls be kind 😛 ).
+
+## FAQ
+
+-   **Why build this??**
+
+*   Why not? Most WebUI's look very dated and now it's no longer necessary to search for a remote control app!
+
+## Support
+
+Reach out to me at one of the following places!
+
+-   <a  href="https://m.me/WijnsDaan"  target="_blank">`Facebook Messenger`</a>
+
+*   Open up an issue 😛
+
+[<img src="https://cdn.buymeacoffee.com/buttons/lato-blue.png" alt="drawing" width="180"/>](https://www.buymeacoffee.com/wdaan 'Buy me a coffee')
+
+## Credits
+
+-   Dashboard design heavily inspired by: '[Net Ninja - Vuetify](https://github.com/iamshaunjp/vuetify-playlist)'.
+    Also check out The Net Ninja's Youtube Channel.
+
+*   This repo '[CzBiX qb-web ](https://github.com/CzBiX/qb-web)'