on master help sign in
added reference to docs and examples in readme
commit8d0909757913e29118961abb7273f1ef68b62dd9 authorSven Koschnicke <s.koschnicke@gfxpro.com> dateSun 29 Oct 2017, 18:45 (9 years ago) parent14dbd39
1 file changed+7−1
README.md+7−1
README.md+7−1
@@ -12,6 +12,13 @@ Supported Docker Engine Api version: `v1.24` and onwards.
1212Anything upward of that should work since Docker versions their API.
1313Older docker version and engine api versions are not supported at the moment.
1414
15+## Documentation
16+
17+The API-documentation is available at
18+[Hackage](https://hackage.haskell.org/package/docker). There are also some
19+usage-examples in the main library source file,
20+[`Client.hs`](https://hackage.haskell.org/package/docker/docs/Docker-Client.html).
21+
1522## Contributing
1623
1724If you wish to contribute please see any issue tagged with "help wanted".
@@ -26,4 +33,3 @@ might not get merged either because of implementation details or other reasons.
2633
2734If you have any questions or suggestions you can find the maintainers in `#docker-haskell`
2835on freenode.
29−