From 8c78dbbb7617d09c9c2e37b552f6964cfc194c1a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9cile=20Vuilleumier?=
 <cecile.vuilleumier@camptocamp.com>
Date: Thu, 22 Aug 2024 11:45:45 +0200
Subject: [PATCH] Add renovate

---
 .github/renovate.json5 | 83 ++++++++++++++++++++++++++++++++++++++++++
 README.md              | 26 +++++++++++++
 2 files changed, 109 insertions(+)
 create mode 100644 .github/renovate.json5

diff --git a/.github/renovate.json5 b/.github/renovate.json5
new file mode 100644
index 0000000..d2dbbf3
--- /dev/null
+++ b/.github/renovate.json5
@@ -0,0 +1,83 @@
+{
+  extends: ["config:base"],
+  timezone: "Europe/Zurich",
+  schedule: "after 5pm on the first day of the month",
+  labels: ["dependencies"],
+  separateMajorMinor: true,
+  separateMinorPatch: true,
+  prHourlyLimit: 0,
+  prConcurrentLimit: 0,
+  lockFileMaintenance: {
+    enabled: true,
+    automerge: true,
+    schedule: "after 5pm on the first day of the month",
+  },
+  baseBranches: ["master"],
+  "pre-commit": { enabled: true },
+  regexManagers: [
+    /** Do updates on pre-commit additional dependencies */
+    {
+      fileMatch: ["^\\.pre\\-commit\\-config\\.yaml$"],
+      matchStrings: [
+        " +- '?(?<depName>[^' @=]+)(@|==)(?<currentValue>[^' @=]+)'? # (?<datasource>.+)",
+      ],
+    },
+  ],
+  packageRules: [
+    /** Auto merge the dev dependency update */
+    {
+      matchDepTypes: ["devDependencies"],
+      automerge: true,
+    },
+    /** Group and auto merge the patch updates */
+    {
+      matchUpdateTypes: ["patch"],
+      groupName: "all patch versions",
+      automerge: true,
+    },
+    /** Group and auto merge the minor updates */
+    {
+      matchUpdateTypes: ["minor"],
+      groupName: "all minor versions",
+      automerge: true,
+    },
+    /** Group Poetry packages */
+    {
+      matchPackagePrefixes: ["poetry-"],
+      groupName: "Poetry",
+      automerge: true,
+      matchDepNames: ["poetry", "pip"],
+    },
+    /** Accept only the patch on stabilization branches */
+    {
+      matchBaseBranches: ["/^[0-9]+\\.[0-9]+$/"],
+      matchUpdateTypes: [
+        "major",
+        "minor",
+        "pin",
+        "digest",
+        "lockFileMaintenance",
+        "rollback",
+        "bump",
+      ],
+      enabled: false,
+    },
+    /** Support the 4 parts of shellcheck-py version with a v prefix */
+    {
+      versioning: "regex:^v(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)\\.(?<build>\\d+)$",
+      matchDepNames: ["shellcheck-py/shellcheck-py"],
+    },
+    /** Disable update of Python version in pyproject.toml */
+    {
+      matchFiles: ["pyproject.toml"],
+      enabled: false,
+      matchDepNames: ["python"],
+    },
+    /** Group and auto merge the CI dependencies */
+    {
+      matchFileNames: [".github/**", ".pre-commit-config.yaml", "ci/**"],
+      groupName: "CI dependencies",
+      automerge: true,
+    },
+  ],
+}
diff --git a/README.md b/README.md
index 69ec5ba..9d437cc 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
 # python-geoservercloud
+
+## Installation
+
+From PyPI:
+
+```shell
+pip install geoservercloud
+```
+
+From git repository:
+
+```shell
+poetry install
+```
+
+## Quick start
+
+```python
+from geoservercloud import GeoServerCloud
+geoserver = GeoServerCloud(
+    url="http://localhost:9090/geoserver/cloud/",
+    user="admin",
+    password="geoserver",
+)
+geoserver.create_workspace("newworkspace")
+```