Create README.md

hirotakan · Dec 10, 2016 · e4afe1e · e4afe1e
1 parent 09d8567
commit e4afe1e
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# go-cleanarchitecture-sample
+Example of a Go application using a clean architecture.
+
+## Install
+Check out the source
+
+```
+cd $WORKDIR
+git clone https://github.com/hirotakan/go-cleanarchitecture-sample.git
+```
+
+Setup the package
+
+```
+cd go-cleanarchitecture-sample/src/app
+glide install
+```
+
+Running with Docker
+
+```
+cd $WORKDIR/go-cleanarchitecture-sample
+docker-compose up
+```
+
+Access the web endpoint at [http://localhost:8080/users](http://localhost:8080/users)