about summary refs log tree commit diff
diff options
context:
space:
mode:
authoremile <hanemile@protonmail.com>2019-05-05 20:27:13 +0000
committeremile <hanemile@protonmail.com>2019-05-05 20:27:13 +0000
commite8904b152f59090da9b15b50a8d0421701559553 (patch)
tree48344fefec0f856dd3d727a7099f431dacf3de06
parent360add0dacd89726346ee898881ed90841548e85 (diff)
Update 'README.md'
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2e2de17..262f8fa 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
 # pixeltsunami
 
+## Command line arguments
+| name | default value | description |
+| -------- | -------- | -------- |
+| host | 127.0.0.1 | Server address (v4) |
+| port | 1337 | Server port |
+| image | foo.png | relative image path |
+| xoffset | 0 | x offset of the image projected |
+| yoffset | 0 | y offset of the image projected |
+| t | false | test the connection before escalating |
+| fill | true | fill the complete canvas |
+| color | 000000 | color used to fill | 
+| cores | 1 | amount of cores used to build the commands |
+