docs: add READMEv0.1.0

1 files changed, 38 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a326c70
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Hugo Theme Techdoc
+
+The Techdoc is Hugo Theme for technical documentation.
+
+## Development environment
+
+```
+cd /path/to/hugo-theme-techdoc
+yarn install
+gulp watch
+```
+
+## Contribution
+
+### Patches and Bug Fixes
+
+Small patches and bug reports can be submitted a issue tracker in Github. Forking on Github is another good way. You can send a pull request.
+
+1. Fork [Hugo Theme Techdoc](http://thingsym.github.io/hugo-theme-techdoc/) from GitHub repository
+2. Create a feature branch: git checkout -b my-new-feature
+3. Commit your changes: git commit -am 'Add some feature'
+4. Push to the branch: git push origin my-new-feature
+5. Create new Pull Request
+
+## Changelog
+
+* Version 0.1.0
+  * initial release
+
+## License
+
+Licensed under the MIT License.
+
+## Author
+
+[thingsym](https://github.com/thingsym)
+
+Copyright (c) 2017-2018 by thingsym