From 1e3d6f375223642212a486b36b73743f07f99ecd Mon Sep 17 00:00:00 2001
From: Pilzinsel64 <pilzinsel64@gmx.de>
Date: Tue, 3 Oct 2023 11:52:27 +0200
Subject: [PATCH] update readme

---
 ...Networking.CloudProviders.Nextcloud.csproj |  8 ++++++
 .../README.md                                 | 27 +++++++++++++++++++
 2 files changed, 35 insertions(+)

diff --git a/Pilz.Networking.CloudProviders.Nextcloud/Pilz.Networking.CloudProviders.Nextcloud.csproj b/Pilz.Networking.CloudProviders.Nextcloud/Pilz.Networking.CloudProviders.Nextcloud.csproj
index 80355fe..e66a32d 100644
--- a/Pilz.Networking.CloudProviders.Nextcloud/Pilz.Networking.CloudProviders.Nextcloud.csproj
+++ b/Pilz.Networking.CloudProviders.Nextcloud/Pilz.Networking.CloudProviders.Nextcloud.csproj
@@ -10,10 +10,18 @@
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <IncrementVersionOnBuild>1.yyyy.Mdd.Hmm</IncrementVersionOnBuild>
     <Version>1.2023.1003.1124</Version>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Update="README.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
 </Project>
diff --git a/Pilz.Networking.CloudProviders.Nextcloud/README.md b/Pilz.Networking.CloudProviders.Nextcloud/README.md
index fc23525..b528fe1 100644
--- a/Pilz.Networking.CloudProviders.Nextcloud/README.md
+++ b/Pilz.Networking.CloudProviders.Nextcloud/README.md
@@ -1 +1,28 @@
 # Nextcloud Client Api
+
+This library is for interactive with Nextcloud instances.
+
+**Beware:** This library is NOT complete. I usually expand it by the functions I need. So, feel free to extend it with your APIs and your functions and submit a Pull Request with the changes.
+
+## How to use
+
+This is a simple shot how the library is intended to be used.
+
+*There are two ways to login. One is the LoginFlowV2.*
+
+```cs
+using NextcloudClient ncClient = new();
+var userInfo = ncClient.Login(creds);
+
+if (userInfo != null)
+{
+    var tableId = 16L;
+    var tablesClient = ncClient.GetClient<TablesClient>();
+    var rows = tablesClient.GetRows(tableId);
+    if (rows != null)
+    {
+        foreach (var row in rows)
+            Console.WriteLine(row.RowId);
+    }
+}
+```
\ No newline at end of file