Removed readme generation, slightly adjusted original readme.

ghga-de · May 23, 2023 · 9b4e60b · 9b4e60b
1 parent 458017a
commit 9b4e60b
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 423 deletions.
diff --git a/.description.md b/.description.md
diff --git a/.design.md b/.design.md
diff --git a/.github/workflows/check_readme.yaml b/.github/workflows/check_readme.yaml
diff --git a/.mandatory_files_ignore b/.mandatory_files_ignore
@@ -6,3 +6,6 @@ Dockerfile
 config_schema.json
 example_config.yaml
 scripts/script_utils/fastapi_app_location.py
+
+.description.md
+.design.md
diff --git a/.readme_template.md b/.readme_template.md
diff --git a/.static_files_ignore b/.static_files_ignore
@@ -12,3 +12,8 @@ scripts/script_utils/cli.py
 
 scripts/update_config_docs.py
 scripts/update_openapi_docs.py
+
+.readme_template.md
+readme_generation.md
+scripts/update_readme.py
+.github/workflows/check_readme.yaml
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 ![tests](https://github.com/ghga-de/ghga-event-schemas/actions/workflows/unit_and_int_tests.yaml/badge.svg)
 [![codecov](https://codecov.io/gh/ghga-de/ghga-event-schemas/branch/main/graph/badge.svg?token=GYH99Y71CK)](https://codecov.io/gh/ghga-de/ghga-event-schemas)
-# GHGA Message Schemas
-A package that collects schemas used for messaging between GHGA service.
+# GHGA Event Schemas
+A package that collects schemas used for events published from and subscribed by GHGA service.
 
 
 ## Quick Start

diff --git a/readme_generation.md b/readme_generation.md