chore: updated the readme of the project

.drone.yml

@@ -87,7 +87,15 @@ steps:
       - buildah login -u $${USERNAME} -p $${PASSWORD} registry.hub.docker.com
       - buildah manifest push --all drone-redmine:latest docker://registry.hub.docker.com/byterazor/drone-redmine:latest 
       - buildah manifest drone-redmine:latest
-
+  - name: push readme
+    image: byterazor/drone-docker-readme-push:latest
+    settings:
+      REPOSITORY_NAME: byterazor/drone-redmine
+      FILENAME: README.md
+      USERNAME: 
+        from_secret: username
+      PASSWORD: 
+        from_secret: password
 depends_on:
   - build-amd64
   - build-arm64

README.md

@@ -1,22 +1,48 @@
-# Redmine Drone Plugin 
+---
+lang: EN_US
+---
+
+# drone-redmine
 
 ## Description
 
-Drone plugin for updating tickits and uploading files in Redmine from within Drone CI/CD pipeline.
+This repository contains a Containerfile for building a drone plugin to interact with the [Redmine](https://redmine.org) API.
+
+### Alert
+
+This is very early work and may and may not work for you yet.
+
+### PLUGIN Variables
+
+* `REDMINE_URL` - the URL to your redmine server (required)
+* `REDMINE_TOKEN` - your Redmine API TOKEN (required)
+* `PROJECT_ID` - the project id (required) to work on
+* `UPLOAD_FILES` - ("true"|"false") - upload files from build (default: "false")
+* `FILES` - space separated list of files to upload in the format PATH:REDMINE_FILENAME:DESCRIPTION:VERSION_ID (optional)
+
+## Supported Architectures
+
+- amd64
+- arm64
+
+## Updates
+
+I am trying to update the image weekly as long as my private kubernetes cluster is available. So I do not promise anything and do **not** rely 
+your business on this image.
 
 
-## Documentation
+## Source Repository
 
-T.B.D
+* https://gitea.federationhq.de/Container/drone-redmine-plugin
 
+## Prebuild Images
+
+* https://hub.docker.com/repository/docker/byterazor/drone-redmine/general
 
 ## Authors
 
-- Dominik Meyer <dmeyer@federationhq.de>
-
-
-## Licsense
-
-Mozilla Public License Version 2.0
+* **Dominik Meyer** - *Initial work* 
 
+## License
 
+This project is licensed under the MPLv2 License - see the [LICENSE](LICENSE) file for details.