From 8d0909757913e29118961abb7273f1ef68b62dd9 Mon Sep 17 00:00:00 2001 From: Sven Koschnicke Date: Sun, 29 Oct 2017 18:45:49 +0100 Subject: [PATCH] added reference to docs and examples in readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 547e397..6b629ea 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,13 @@ Supported Docker Engine Api version: `v1.24` and onwards. Anything upward of that should work since Docker versions their API. Older docker version and engine api versions are not supported at the moment. +## Documentation + +The API-documentation is available at +[Hackage](https://hackage.haskell.org/package/docker). There are also some +usage-examples in the main library source file, +[`Client.hs`](https://hackage.haskell.org/package/docker/docs/Docker-Client.html). + ## Contributing If 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. If you have any questions or suggestions you can find the maintainers in `#docker-haskell` on freenode. -