aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLionel <lionel.miquel46@gmail.com>2018-10-29 20:41:44 +0100
committerLionel <lionel.miquel46@gmail.com>2018-10-29 20:41:44 +0100
commit687df02d8a8711342d9061b60d06266cc01b0c35 (patch)
tree00dd47544a7a060299340097be429581448f7d7e /README.md
parent1f2157d7eec798c569be0231cc9415da1d9f4e58 (diff)
downloadrandopitons-687df02d8a8711342d9061b60d06266cc01b0c35.tar.gz
randopitons-687df02d8a8711342d9061b60d06266cc01b0c35.zip
Updated the README.md with usage. Code needs cleanup.
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 24 insertions, 3 deletions
diff --git a/README.md b/README.md
index c4feb0c..0731c3e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,27 @@
# randopitons
-Work in progress.
-Currently have issues with file downloading and some errors handling.
+Hello !
+Here's a bash script for downloading hitchiking files from [https://randopitons.re](https://randopitons.re)
+You will need to make an account on the website before using the script (as these credentials are needed).
+
+## Installation
+
+If you have git installed on your computer, you can clone it by doing:
+```bash
+git clone https://github.com/MIQUELLIONEL/randopitons
+cd randopitons
+```
+Then `bash randopitons.sh` followed by options.
+
+## Usage
+The following options are mandatory:
+`--username/-u "your-username-or-email@randopitons.re"`: After that, you will be prompted for your password (it won't display it as you type so don't worry, it's for protecting you from curious peoples looking at you screen (a.k.a shouldersurfing).
+
+Facultative:
+`--maptype/-mp maptype`: Can be used to specify a particular filetype to download between the 3 choices available. See \"-lm\" for more info
+`--list-regions/-lr`: Display the list of available regions.
+`--list-maptype/-lm`: Display the list of available maptypes.
+`--region/-r "string"`: Will download the matching regions from the string.
+`--all/-a`: Will download all the files from all regions
# LICENSE
@@ -18,4 +39,4 @@ Currently have issues with file downloading and some errors handling.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.
-```
+```