From 4a4622fda53e32029e0e7fe3163adf2e32c48f51 Mon Sep 17 00:00:00 2001 From: Dessalines Date: Fri, 12 Oct 2018 09:49:34 -0700 Subject: [PATCH] Updating readme to show requirements before examples --- README.md | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1e76e48..3458bbc 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ `Torrents.csv` will only store torrents with at least one seeder to keep the file small, and will be periodically purged of non-seeded torrents, and sorted by seeders descending. -It also comes with a simple [Torrents.csv webserver](https://torrents-csv.ml) +It also comes with a self-hostable [Torrents.csv webserver](https://torrents-csv.ml) ![img](https://i.imgur.com/qVmSVMC.png) @@ -14,6 +14,12 @@ Made with [Rust](https://www.rust-lang.org), [ripgrep](https://github.com/BurntS ## Searching +### Requirements + +- [ripgrep](https://github.com/BurntSushi/ripgrep) + +### Running + To find torrents, run `./search.sh "bleh season 1"` ``` bleh season 1 (1993-) @@ -24,12 +30,28 @@ bleh season 1 (1993-) ## Running the webserver +### Requirements + +- Rust +- ripgrep +- Yarn + +### Running + `Torrents.csv` comes with a simple webserver. Run `cd scripts && ./webserver.sh`, and goto http://localhost:8080 ## Uploading An *upload*, consists of making a pull request after running the `add_torrents.sh` script, which adds torrents from a directory you choose to the `.csv` file, after checking that they aren't already there, and that they have seeders. +### Requirements + +- [Torrent tracker scraper](https://github.com/ZigmundVonZaun/torrent-tracker-scraper) +- [Transmission-cli](https://transmissionbt.com/) +- [Human Friendly](https://humanfriendly.readthedocs.io/en/latest/readme.html#command-line) + +### Running + [Click here](https://gitlab.com/dessalines/torrents.csv/forks/new) to fork this repo. ```sh git clone https://gitlab.com/[MY_USER]/torrents.csv @@ -48,22 +70,8 @@ infohash;name;size_bytes;created_unix;seeders;leechers;completed;scraped_date # torrents here... ``` -## Requirements +Made with [Rust](https://www.rust-lang.org), [ripgrep](https://github.com/BurntSushi/ripgrep), [Actix](https://actix.rs/), [Inferno](https://www.infernojs.org), and [Typescript](https://www.typescriptlang.org/). -### Searching -- [ripgrep](https://github.com/BurntSushi/ripgrep) - -### Web server - -- Rust -- ripgrep -- Yarn - -### Uploading - -- [Torrent tracker scraper](https://github.com/ZigmundVonZaun/torrent-tracker-scraper) -- [Transmission-cli](https://transmissionbt.com/) -- [Human Friendly](https://humanfriendly.readthedocs.io/en/latest/readme.html#command-line) ## Potential sources for new torrents