From 21f385811c0e2920f82ed6c83da9559976342b05 Mon Sep 17 00:00:00 2001
From: Dorian Turba <froggit.commit.z3jqj@simplelogin.com>
Date: Mon, 28 Aug 2023 21:59:45 +0200
Subject: [PATCH] update README.md

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5c57134..a3b35b6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
 # CI templates for R2DevOps open source catalog
-This repository contains CI templates for R2DevOps open source catalog.
+
+This repository contains CI templates dedicated to Python software testing for the R2DevOps open source catalog.
+
+## Purpose
+The CI templates in this repository are intended for integrating Python software testing tools with your GitLab projects. They provide streamlined configurations for tools like `pytest` and `mypy`.
+
+## Usage
+To utilize these templates in your GitLab projects:
+
+1. Navigate to the [r2devops template marketplace](https://r2devops.io/dashboard/marketplace?search=r2_metadata),
+2. Choose the template you want,
+3. Paste the "Quick use" snippet into your GitLab CI configuration (`.gitlab-ci.yml`).
+
+For example, to use the `pytest` template:
+
+```yaml
+stages:
+  - test  
+
+include:
+  - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba/r2devops_catalog/r2_metadata/pytest@latest.yaml'
+```
+
+## Contributions
+We welcome contributions from the community! For guidelines on contributing, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## Prerequisites
+To use the templates from this repository, ensure that you have at least GitLab version `15.10.7`.
+
+## Directory Structure
+- `r2_metadata` - Contains the R2DevOps metadata files.
+- `templates` - Contains the CI templates.
+- `test` - Contains test projects used to test each template.
+k
\ No newline at end of file
-- 
GitLab