Merge pull request #12 from gokulnair2001/develop

Doc Updation
gokulnair2001 · Jun 20, 2023 · 826184a · 826184a · vercel · Jun 20, 2023
2 parents c277cbf + 3ae0832
commit 826184a
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/Sources/OSLogKit/Documentation.docc/Documentation.md b/Sources/OSLogKit/Documentation.docc/Documentation.md
@@ -0,0 +1,24 @@
+# ``OSLogKit``
+
+A Layer 2 framework for OSLog which makes its adoption more easier⌨️
+
+## Overview
+
+OSLogKit is a layer 2 framework developed on top of the native OSLog system, aiming to simplify the integration of OSLog into your project. Apple has done an excellent job in ensuring that OSLogging is straightforward and easy to use. However, when it comes to implementing OSLog in your codebase, can be challenging.
+
+To address this, OSLogKit has been developed, further simplifying the process of adopting OSLog. One notable advantage of OSLogKit is that it offers additional functionalities not available in the native API.
+
+OSLogKit has a variety of Modifiers which makes OSLogKit adoption very easy. Don't worry if your code base is in UIKit, you can still adopt it quickly.
+
+![OSLogKit](OSLogKit@2x.png)
+
+## Topics
+
+### Essentials
+
+- ``OSLogKit``
+
+### Types
+
+- ``OSLogError``
+- ``OSLogSpan``
diff --git a/Sources/OSLogKit/Documentation.docc/Resources/OSLogKit@2x.png b/Sources/OSLogKit/Documentation.docc/Resources/OSLogKit@2x.png