about summary refs log tree commit diff
diff options
context:
space:
mode:
authorhanemile <mail@emile.space>2020-07-02 21:22:24 +0200
committerhanemile <mail@emile.space>2020-07-02 21:22:24 +0200
commitef58f02e4e3e45b64b398d3884b54b2f7729a6c7 (patch)
treea23baa0dfaf2c13bfcd0e07b181b87fff1bc29db
parent9095838d3c02c864c7a9642f492aa8387b58744e (diff)
added an example to the README
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index c14ba21..5117533 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ go build ./...
 ## Usage
 
 ```
-./ctfdget --help                                                                                                                                                                                                                                                                                                                                             [±master ●]
+./ctfdget --help
 Usage of ./ctfdget:
   -out string
     	The name of the folder to dump the files to (default "challdump")
@@ -27,6 +27,23 @@ Usage of ./ctfdget:
 		The root URL of the CTFd instance (default "https://ctf.example.com")
 ```
 
+Example:
+
+```
+$ go run ./... -session 9e8831af-ce30-48c3-8663-4b27262f43f1.pjKPVCYufDhuA9GPJAlc_xh45M8 -url https://cscml.zenysec.com -out cscmlctf
+Fetching all challenges using the ctf api...
+Done fetching all challenges
+Downloading the files included in the challenges
+→ cscmlctf/misc/Censored
+→ cscmlctf/web/WebServer I
+→ cscmlctf/misc/Thanos
+→ cscmlctf/web/Scrolls List
+→ cscmlctf/pwn/WebServer II
+→ cscmlctf/machine learning/Prosopagnosia
+→ cscmlctf/misc/JSGame
+…
+```
+
 ## Features
 
 - Dump all files from all challenges