Initial commit

1 files changed, 36 insertions, 1 deletions

diff --git a/README.md b/README.md
index bc0da50..c14ba21 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
 # ctfdget
-Simply fetch all challenges from a CTF hosted using CTFd.
+
+Ever started playing a ctf hosted using CTFd that felt like the requests were
+processed manually by a goat? Not being able to access the challenges, but
+being able to access the api? Just wanting to download all challenges at once
+for not having to deal with CTFd until you want to submit your flags?
+
+Here it is: ctfdget, a simple tool for fetching all challenges with their
+included files.
+
+## Building 
+
+```
+go build ./...
+```
+
+## Usage
+
+```
+./ctfdget --help                                                                                                                                                                                                                                                                                                                                             [±master ●]
+Usage of ./ctfdget:
+  -out string
+    	The name of the folder to dump the files to (default "challdump")
+  -session string
+    	The session (the value of the cookie named 'session') (default "9e8831af-ce30-48c3-8663-4b27262f43f1.pjKPVCYufDhuA9GPJAlc_xh45M8")
+  -url string
+		The root URL of the CTFd instance (default "https://ctf.example.com")
+```
+
+## Features
+
+- Dump all files from all challenges
+- A simple directory structure get's created sorting the challenges into the corresponding categories (<ctfname>/<category>/<challengename>/<challengefiles>)
+
+## Contribution
+
+Just open issues, pull requests or whatever and we'll work something out