add details to the readme

Author: gesellix

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+## Applying api changes
+
+1. navigate to the subproject(s) matching the api version(s) to be changed
+2. update the `docker-engine-api-v<VERSION>.yaml`
+3. execute in the project's root directory: `./gradlew :api-model-v<VERSION>:updateApiModelSources`
+4. verify the code changes, e.g. using `git status` or `git diff`
+5. perform checks: `./gradlew check`
+6. push the changes to your fork and submit a pull request (see [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) for help about contributing to a project)

README.md

@@ -1,5 +1,48 @@
 # docker-remote-api
 
-Official documentation: https://docs.docker.com/engine/api/
-API reference (latest release): https://docs.docker.com/engine/api/latest/
-API reference source: https://github.com/moby/moby/blob/master/api/swagger.yaml
+_This project is Work In Progress_
+
+A Docker Remote API model generated from the official OpenAPI spec.
+Every engine api version is modeled as dedicated subproject and published artifacts.
+
+## Usage
+
+Consumers can choose a matching api model by specifying the correct library.
+The api version is part of the artifact-id, so that we're able to evolve
+each api model independently. See the examples below how to include the model
+in your project.
+
+Gradle:
+
+```groovy
+implementation("de.gesellix:docker-remote-api-model-1-41:[2021-10-16T19-28-00,)")
+```
+
+Maven:
+
+```xml
+<dependency>
+    <groupId>de.gesellix</groupId>
+    <artifactId>docker-remote-api-model-1-41</artifactId>
+    <version>[2021-10-16T19-28-00,)</version>
+</dependency>
+```
+
+## API Documentation
+
+- Official documentation: https://docs.docker.com/engine/api/
+- API reference (latest release): https://docs.docker.com/engine/api/latest/
+- API reference source: https://github.com/moby/moby/blob/master/api/swagger.yaml
+
+## Contact
+
+Please leave feedback, ideas for improvements, or bug reports as [issues](https://github.com/docker-client/docker-remote-api/issues).
+
+Feel free to submit [pull requests](https://github.com/docker-client/docker-remote-api/pulls)!
+See [CONTRIBUTING](CONTRIBUTING.md) for details how to apply api or code changes.
+
+I'm available at Twitter [@gesellix](https://twitter.com/gesellix), too.
+
+## License
+
+See the [LICENSE](LICENSE) file.