From b994d9f74f543e69c3b6e3feb028c322d1cd91d0 Mon Sep 17 00:00:00 2001
From: Bas Harenslak <bas@astronomer.io>
Date: Mon, 11 Dec 2023 15:47:38 -0500
Subject: [PATCH] Fix some info in the readme

---
 README.md | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 05f09e3..82df11f 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,20 @@ This Python library hosts custom Airflow Operators, Sensors, Notifiers, etc. tha
 
 ## Installing the library
 
-Add `democorp_airflow` to your `requirements.txt`.
+Since this repository is built only for example purposes, we publish a Python package only to [TestPyPI](https://test.pypi.org/project/democorp-airflow). Therefore, you'll need to add TestPyPI as an (extra) index URL. You can install the package using pip:
+
+```bash
+pip install -i https://test.pypi.org/simple/ democorp-airflow
+```
+
+Or when installing from a requirements.txt file:
+
+```text
+--extra-index-url https://test.pypi.org/simple
+democorp_airflow
+
+# Install with "pip install -r requirements.txt" 
+```
 
 ## Using the library
 
@@ -37,14 +50,16 @@ from democorp_airflow.operators.example import ExampleOperator
 
 ## Versioning
 
-We use `setuptools-scm` to automatically manage versioning based on git tags. When you create a new tag, the library version is updated accordingly. See [1](https://github.com/pypa/setuptools_scm/), [2](https://www.moritzkoerber.com/posts/versioning-with-setuptools_scm/) for more details.
+We use `setuptools-scm` to automatically manage versioning based on git tags. When you create a new tag, the library version is updated accordingly, and a release for the given tag is made. See the files in `.github/workflows` for inspiration.
+
+See [1](https://github.com/pypa/setuptools_scm/), [2](https://www.moritzkoerber.com/posts/versioning-with-setuptools_scm/) for more details.
 
 ## Continuous Integration/Continuous Deployment (CI/CD)
 
 Our CI/CD pipeline is managed using GitHub Actions:
 
-- On every commit, syntax checks and unit tests are run to ensure code quality.
-- When a new tag is pushed, the library is built (and should be pushed to a registry such as PyPI or Artifactory).
+- On every commit, syntax checks and unit tests are run to ensure code quality. See `.github/workflows/ci.yaml`.
+- When a new tag is pushed, the library is built, published to TestPyPI, and a GitHub release is created. See `.github/workflows/publish.yaml`.
 
 ## Contributing
 
@@ -53,7 +68,7 @@ We welcome contributions from every team to improve this library! Here's how you
 ### Getting started
 
 1. Clone the repository to your local machine.
-1. Create a new branch for your changes: `git checkout -b feature/your-feature-name`.
+1. Create a new branch for your changes: `git checkout -b my-new-feature`.
 
 ### Making changes