add readme with single namespace info

kontent-ai · Nov 24, 2021 · 2f4304f · 2f4304f
1 parent c84264f
commit 2f4304f
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/Kentico.Kontent.Delivery.Abstractions/README.md b/Kentico.Kontent.Delivery.Abstractions/README.md
@@ -0,0 +1,17 @@
+# Kontent Delivery Abstractions
+
+This library was introduced in [version 14](https://github.com/Kentico/kontent-delivery-sdk-net/releases/tag/14.0.0). It provides a set of abstractions for working with Kontent Delivery SDK.
+
+All of the types should **use the same namespace** to make the whole API easily discoverable.
+
+> Do not use sub-namespaces.
+
+```csharp
+namespace Kentico.Kontent.Delivery.Abstractions
+{
+    public interface MyClass
+    {
+        // ...
+    }
+} 
+```