diff --git a/README.md b/README.md
new file mode 100644
index 0000000..02a9e21
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+## PAWE.ME
+Simple mirroring & archiving server.
+
+- This script is used to serve ![pawe.me](https://pawe.me) mirroring server.
+
+- config.yaml contains various config options, can add more repo/upstream with just adding to config. supports http, rsync, ftpsync(debian).
+
+- ~~HTTP Mirroring uses custom python script using aiohttp, may change to wget recursive mirroring..~~ fixing script, currently just fetches in order.
+
+- $BASE_DIR is where all data is stored. Need to change manually in script index.py
+
+- index.py renders index.html file after each sync, order and half-size card can be configured in config.yml