diff --git a/examples/shipping/README.md b/examples/shipping/README.md index 47b2a0b..cbcc4df 100644 --- a/examples/shipping/README.md +++ b/examples/shipping/README.md @@ -1,10 +1,8 @@ -shipping -======== +# shipping This example demonstrates a more real-world application consisting of multiple services. -Description ------------ +## Description The implementation is based on the container shipping domain from the [Domain Driven Design](http://www.amazon.com/Domain-Driven-Design-Tackling-Complexity-Software/dp/0321125215) book by Eric Evans, which was [originally](http://dddsample.sourceforge.net/) implemented in Java but has since been ported to Go. This example is a somewhat stripped down version to demonstrate the use of Go kit. The [original Go application](https://github.com/marcusolsson/goddd) is maintained separately and accompanied by an [AngularJS application](https://github.com/marcusolsson/dddelivery-angularjs) as well as a mock [routing service](https://github.com/marcusolsson/pathfinder). @@ -22,7 +20,6 @@ The `routing` package provides a _domain service_ that is used to query an external application for possible routes. -Contributing ------------- +## Contributing As with all Go kit examples you are more than welcome to contribute. If you do however, please consider contributing back to the original project as well.