chore

Author: gesellix

README.md

@@ -1,14 +1,11 @@
-# docker-filesocket
+[![Build Status](https://img.shields.io/github/workflow/status/docker-client/docker-filesocket/Publish?style=for-the-badge)](https://github.com/docker-client/docker-filesocket/actions)
+[![Maven Central](https://img.shields.io/maven-central/v/de.gesellix/docker-filesocket.svg?style=for-the-badge&maxAge=86400)](https://search.maven.org/search?q=g:de.gesellix%20AND%20a:docker-filesocket)
 
-Unix domain socket and named pipe abstraction for the docker-client
+# docker-filesocket
 
-## Release Workflow
+[Unix domain socket](https://en.wikipedia.org/wiki/Unix_domain_socket) and [named pipe](https://en.wikipedia.org/wiki/Named_pipe#In_Windows) abstraction
+for the [docker-client](https://github.com/gesellix/docker-client).
 
-There are multiple GitHub Action Workflows for the different steps in the package's lifecycle:
+## Publishing/Release Workflow
 
-- CI: Builds and checks incoming changes on a pull request
-    - triggered on every push to a non-default branch
-- CD: Publishes the Gradle artifacts to GitHub Package Registry
-    - triggered only on pushes to the default branch
-- Release: Publishes Gradle artifacts to Sonatype and releases them to Maven Central
-    - triggered on a published GitHub release using the underlying tag as artifact version, e.g. via `git tag -m "$MESSAGE" v$(date +"%Y-%m-%dT%H-%M-%S")`
+See RELEASE.md

RELEASE.md

@@ -0,0 +1,15 @@
+## Publishing
+
+Packages are automatically published from the `main` branch to the GitHub Package Registry.
+Manually cut releases will be published to both GitHub Package Registry and Maven Central.
+
+## Release Workflow
+
+There are multiple GitHub Action Workflows for the different steps in the package's lifecycle:
+
+- CI: Builds and checks incoming changes on a pull request
+  - triggered on every push to a non-default branch
+- CD: Publishes the Gradle artifacts to GitHub Package Registry
+  - triggered only on pushes to the default branch
+- Release: Publishes Gradle artifacts to Sonatype and releases them to Maven Central
+  - triggered on a published GitHub release using the underlying tag as artifact version, e.g. via `git tag -m "$MESSAGE" v$(date +"%Y-%m-%dT%H-%M-%S")`