added docker run instructions

linksmart · Apr 3, 2020 · 19f7ca3 · 19f7ca3
1 parent 5428cb0
commit 19f7ca3
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,16 @@ This is currently under development.
 ## Getting Started
 API Documentation: [OpenAPI Specification](https://linksmart.eu/swagger-ui/dist/?url=https://raw.githubusercontent.com/linksmart/thing-directory/master/apidoc/openapi-spec.yml)
 
+## Deployment
+### Docker
+The following command runs the latest build of Thing Directory with the default configuration file ([/conf/thing-directory.json](https://github.com/linksmart/thing-directory/blob/master/sample_conf/thing-directory.json)):
+```
+docker run -p 8081:8081 linksmart/td
+```
+The index of the RESTful API should now be accessible at: http://localhost:8081
+
+Please refer to the API Documentation to learn about the different endpoints.
+
 ## Development
 The dependencies of this package are managed by [Go Modules](https://github.com/golang/go/wiki/Modules).