Add documentation

.github/workflows/README.md

@@ -0,0 +1,24 @@
+# GitHub Workflows
+
+This document describes the GitHub workflows used in this project.
+
+## Build
+
+Builds, Lint, Test on different node versions
+
+Publishes the docker image with version `x.y.z-pr.<PR_NUMBER>`
+
+## Merge PR
+
+Publishes the docker image with `latest`
+
+## Close release
+
+This is a workflow triggered manually from Github Actions [Close Release](https://github.com/hoprnet/uHTTP-exit-app/actions/workflows/release.yaml). The tasks performed by this workflow include:
+
+- Publishes the docker image with `x.y.z`
+- Create a Github release
+- Tag code
+- Changelog is autogenerated by commit linear history of the release
+- Bumps the new version by opening a new PR
+- Sends a Zulip notification

README.md

@@ -4,14 +4,10 @@
 
 uHTTP exit application attaches to an exit node and performs arbitrary incoming HTTP requests for clients.
 
-## Deployment
+## Deployment process
 
-CI will create a new container image on a tagged version on main.
+To contribute to this repository you will need to create a pull request. More information about the existing automated workflows can be found in [GitHub Actions](./.github/workflows/README.md)
 
--   run `yarn changeset version` to create the current changelog
--   run `yarn build` to update version info
--   commit everything, create a matching tag and push to main
--   update container tag `stable` in container registry as needed
 
 ## Run with Docker