diff --git a/README.md b/README.md
new file mode 100644
index 0000000..797fbc1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# api-documentation
+
+## Deployment
+
+Currently the [swagger.json](./public/rest/swagger.json) needs to be manually updated. You can create a pull request with copying it from https://gateway.farajaland-staging.opencrvs.org/swagger.json for example. Then GitHub Pages gets automatically deployed when merged to main.