diff --git a/README.md b/README.md index d28c3f7..9c185ba 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,9 @@ Made with [Rust](https://www.rust-lang.org), [ripgrep](https://github.com/BurntS ### Requirements -- Rust -- Yarn +- [Rust](https://www.rust-lang.org/) +- [Yarn](https://yarnpkg.com/en/) +- [SQLite3](https://www.sqlite.org/index.html) ### Running @@ -36,6 +37,14 @@ and goto http://localhost:8080 If running on a different host, run `export TORRENTS_CSV_ENDPOINT=http://whatever.com` to change the hostname. +The torrent data is updated daily, and to do so, run: +``` +cd scripts +./git_update.sh +``` + +This updates the repository, and rebuilds the sqlite cache necessary for searching. + ### Docker ``` @@ -70,8 +79,8 @@ An *upload*, consists of making a pull request after running the `scan_torrents. - [Torrent-Tracker-Health Dessalines branch](https://github.com/dessalines/torrent-tracker-health) - `npm i -g dessalines/torrent-tracker-health` - [jq command line JSON parser](https://stedolan.github.io/jq/) -- [Cloudflare Scrape](https://github.com/Anorov/cloudflare-scrape) - - `sudo pip install cfscrape` +- [NodeJS](https://nodejs.org/en/) +- [Gnu Parallel](https://www.gnu.org/software/parallel/) ### Running @@ -93,6 +102,8 @@ Then [click here](https://gitlab.com/dessalines/torrents.csv/merge_requests/new) ### Requirements - Rust +- [Cloudflare Scrape](https://github.com/Anorov/cloudflare-scrape) + - `sudo pip install cfscrape` ### Running @@ -102,7 +113,7 @@ cd torrents.csv/scripts ./update.sh SAVE_TORRENT_DIR ``` -## How the .csv file looks +## How the torrents.csv file looks ```sh infohash;name;size_bytes;created_unix;seeders;leechers;completed;scraped_date