From a3bb4dfb9285f7cc8adb298fff41bd35e0e54520 Mon Sep 17 00:00:00 2001
From: Mindsers <dev@nathanaelcherrier.com>
Date: Mon, 25 Sep 2017 00:35:26 +0200
Subject: [PATCH] Add readme

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..9b4e7c8b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# configfiles
+
+**configfiles** is a command line tool that help user to manage their own configuration files.
+
+## Data storage
+
+This tool does not store configuration files for you. A git repo is needed to store your configuration files.
+
+Please follow this structure:
+
+```txt
+/files/
+    /module1/
+    /module2/
+        /settings.json
+        /configurationfile.txt
+    /module3/
+/scripts/
+    /scriptfile.sh
+```
+
+## Usage
+
+### Initialization / configuration
+
+`configfiles init` Initialize *configfiles* on the current user session.
+
+### Deploy configuration files
+
+`configfiles deploy [moduleName...]` Deploy the configuration files for the given module name.
+
+### Run script
+
+`configfiles run <scriptName>` Execute the script identifying by the given script name.
+
+## License
+
+This project is under Apache-2.0 license. See LICENSE file.