diff --git a/README.md b/README.md index 692ed186..b24248dd 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,58 @@ -# Vuetorrent +# VueTorrent -## Project setup -``` -- development + A modern looking WEBUI for qBittorrent made with Vuejs & express! + + (support for more clients coming in the future) + + ## Screenshots + +

+ Desktop Screenshot +

+ +

+ Mobile Screenshot +

-npm install & npm run serve -- production +> Vue, Node, Express, qBitorrent -npm install & npm run build -then copy dist to server/dist -rename config.example.json to config.json -run node server/src/server.js -``` \ No newline at end of file +## Installation + +- Probably a Docker image but I haven't properly figured out this part yet... + +### Development + +FRONTEND : Git clone & npm run serve! + +SERVER : (npm run build, copy dist to server (optional)) & nodemon server.js! + +--- + +## 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...) + +## Contributing + +I'll gladly accept help & advice! (this is my first project of this nature, pls be kind :P ). + +## 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! + +- `Facebook Messenger` +- Open up an issue :P + +--- + +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)