From 612b29cda6d210d4f23e98e84ec998833098b042 Mon Sep 17 00:00:00 2001
From: Adora Laura Kalb <adora@lila.network>
Date: Sat, 3 Aug 2024 17:20:51 +0200
Subject: [PATCH] update docs and changelog for 0.1.0

---
 CHANGELOG.md | 44 ++------------------------------------------
 README.md    | 17 +++++++++++++++++
 2 files changed, 19 insertions(+), 42 deletions(-)
 create mode 100644 README.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7abb56a..84b4972 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,52 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## [Unreleased]
-## [0.2.2] - 2024-07-30
-
-### Changed
-- changed the way the version string is handled internally
-- CI pipeline changed
-- documentation is now more sophisticated and has a new theme
-
-### Added
-- Makefile
-
-## [0.2.1] - 2024-07-12
-### Fixed
-- Configuration validation did not work as intended
-
-### Changed
-- updated example config file
-
-## [0.2.0] - 2024-07-11
-### ⚠️ Breaking Changes
-- Config file syntax was changed to accomodate both private and public key deployment for certificates. 
-
-    This change is __NOT__ backwards compatible!
-    The following yaml keys were changed/added:
-    - `api_key`: changed to `cert_secret`
-    - `file_path`: changed to `cert_path`
-    - added keys: `key_secret`, `key_path`
-
-### Changed
-- config file syntax to enable deployment of private keys too
-- refactor code
-
-## [0.1.1] - 2024-07-03
-
-### Fixed
-- Fixed handling of the post certificate action
-
-## [0.1.0] - 2024-07-03
+## [0.1.0] - 2024-08-03
 
 ### Added
 - Minimal viable application
 - some documentation
 
 
-[unreleased]: https://code.lila.network/adoralaura/forgejo-release-proxy/compare/0.2.2...HEAD
-[0.2.2]: https://code.lila.network/adoralaura/forgejo-release-proxy/compare/0.2.1...0.2.2
-[0.2.1]: https://code.lila.network/adoralaura/forgejo-release-proxy/compare/0.2.0...0.2.1
-[0.2.0]: https://code.lila.network/adoralaura/forgejo-release-proxy/compare/0.1.1...0.2.0
-[0.1.1]: https://code.lila.network/adoralaura/forgejo-release-proxy/compare/0.1.0...0.1.1
+[unreleased]: https://code.lila.network/adoralaura/forgejo-release-proxy/compare/0.1.0...HEAD
 [0.1.0]: https://code.lila.network/adoralaura/forgejo-release-proxy/releases/tag/0.1.0
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a53b2b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# adoralaura/forgejo-release-proxy
+
+listens to 0.0.0.0:8080 by default
+
+## API-Endpoints
+### `/api/v1/code.lila.network/releases`
+Query parameters: 
+
+- `namespace`: Repo Namespace, format: `adoralaura/forgejo-release-proxy`
+
+### `/__version__`
+Version string
+### `/__heartbeat__`
+returns status 200
+### `/__lbheartbeat__`
+returns status 200
+