on master help sign in
added reference to docs and examples in readme
8d09097Sven Koschnicke
README.md+7−1
@@ -12,6 +12,13 @@ Supported Docker Engine Api version: `v1.24` and onwards.
12Anything upward of that should work since Docker versions their API.
12Anything upward of that should work since Docker versions their API.
13Older docker version and engine api versions are not supported at the moment.
13Older docker version and engine api versions are not supported at the moment.
14
14
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+
15## Contributing
22## Contributing
16
23
17If you wish to contribute please see any issue tagged with "help wanted".
24If 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.
26
33
27If you have any questions or suggestions you can find the maintainers in `#docker-haskell`
34If you have any questions or suggestions you can find the maintainers in `#docker-haskell`
28on freenode.
35on freenode.
29−