From a4b0609e9e0238af8671a1423372672cf31e82d8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9cile=20Vuilleumier?=
 <cecile.vuilleumier@camptocamp.com>
Date: Wed, 9 Oct 2024 17:25:19 +0200
Subject: [PATCH] Add examples in README

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)

diff --git a/README.md b/README.md
index 9d437cc..dbab246 100644
--- a/README.md
+++ b/README.md
@@ -25,3 +25,71 @@ geoserver = GeoServerCloud(
 )
 geoserver.create_workspace("newworkspace")
 ```
+
+## About
+
+Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services.
+Intended use cases are listed below.
+
+### Programmatic setup of a GeoServer catalog
+
+For example, creating a workspace, connecting to a PostGIS datastore and publishing a PG layer:
+
+```python
+geoserver.create_workspace("example")
+geoserver.create_pg_datastore(
+    workspace="example",
+    datastore="example_store",
+    pg_host="localhost",
+    pg_port=5432,
+    pg_db="database",
+    pg_user="user",
+    pg_password="password"
+)
+geoserver.create_feature_type(
+    layer="layer_example"
+    workspace="example",
+    datastore="example_store",
+    title={
+        "en":"Layer title",
+        "fr": "Titre de la couche",
+        "default": "Default title",
+    },
+)
+```
+
+### Testing
+
+Automatic tests of GeoServer functionalities with `pytest`, for example before upgrading.
+The example below tests the fallback mechanism for internationalized layer titles in the GetCapabilities document.
+
+```python
+@pytest.mark.parametrize(
+    "language,expected_title",
+    [
+        (
+            "en",
+            "Layer title",
+        ),
+        (
+            "fr",
+            "Titre de la couche",
+        ),
+        (
+            "de,en",
+            "Layer title",
+        ),
+        (
+            None,
+            "Default title",
+        ),
+    ],
+)
+def test_i18n_layer_title(geoserver, language, expected_title):
+    capabilities = geoserver.get_wms_layers(
+        workspace="example",
+        accept_languages=language,
+    )
+    layer = capabilities.get("Layer")
+    assert layer.get("Title") == expected_title
+```