aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLionel <lionel.miquel46@gmail.com>2018-11-05 13:37:32 +0100
committerLionel <lionel.miquel46@gmail.com>2018-11-05 13:37:32 +0100
commit8efb8bc85106f6ee489e99b86271374a48cd48ce (patch)
treea62c1c813f5b52203a0ff81dbcee8065438299ac /README.md
parente86548a0c5852816fa5d315669fe0032ca69c3f1 (diff)
downloadrandopitons-8efb8bc85106f6ee489e99b86271374a48cd48ce.tar.gz
randopitons-8efb8bc85106f6ee489e99b86271374a48cd48ce.zip
Updated and cleaned the README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 7 insertions, 33 deletions
diff --git a/README.md b/README.md
index 4572533..77c6b59 100644
--- a/README.md
+++ b/README.md
@@ -14,37 +14,11 @@ 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
-
+Type the following:
+```bash
+man randopitons.7
+```
+or
+```bash
+bash randopitons.sh -h
```
- DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
- Version 2, December 2004
-
- Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
-
- Everyone is permitted to copy and distribute verbatim or modified
- copies of this license document, and changing it is allowed as long
- as the name is changed.
-
- DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. You just DO WHAT THE FUCK YOU WANT TO.
-```