Merge pull request #15 from directorz/feature/documentation

Feature/documentation

README.md

@@ -66,3 +66,8 @@ Add a new domain and user.
 ```
 
 Enjoy!
+
+More info
+---------
+
+See [documentation](doc/README.md)

doc/README.md

@@ -0,0 +1,5 @@
+Documentation
+=============
+
+- [Configuration](configuration.md)
+- [Migrating from mailfull](migrating_from_mailfull.md)

doc/configuration.md

@@ -0,0 +1,12 @@
+Configuration
+=============
+
+`.mailfull/config`
+
+| key | type | default | required | description |
+|:----|:-----|:--------|:---------|:------------|
+| dir_database | string | `"./etc"` | no | A relative path from repository dir (or a absolute path) |
+| dir_maildata | string | `"./domains"` | no | A relative path from repository dir (or a absolute path) |
+| username | string | The username who executed `mailfull init` | **yes** | It used for setting owner of database files and maildata files. |
+| cmd_postalias | string | `"postalias"` | no | Command name or path |
+| cmd_postmap | string | `"postmap"` | no | Command name or path |

doc/migrating_from_mailfull.md

@@ -0,0 +1,24 @@
+Migrating from mailfull
+=======================
+
+Migrating from [directorz/mailfull](https://github.com/directorz/mailfull)
+
+Change directory to Mailfull directory.
+
+```
+# su - mailfull
+$ cd /home/mailfull
+```
+
+Initialize a directory as a Mailfull repository.
+
+```
+$ mailfull init
+```
+
+Delete unnecessary files.
+
+```
+$ rm -rf .git .gitignore bin docs lib README.md README.ja.md
+$ find domains -maxdepth 2 -name '.vforward' | xargs rm -f
+```