From 67c1176ab717d84f5d0e62517e881a1194609b5a Mon Sep 17 00:00:00 2001 From: Daniel Saidi Date: Sun, 6 Oct 2024 13:36:02 +0200 Subject: [PATCH] Update documentation --- README.md | 4 ++-- Sources/SwiftUIKit/SwiftUIKit.docc/SwiftUIKit.md | 16 ++++++++++++++-- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index aa69bece66..68e37bcb43 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,9 @@ https://github.com/danielsaidi/SwiftUIKit.git ## Getting Started -SwiftUIKit started as a small project, but has grown big over the years. Due to its complexity, I have decided to remove the demo. Instead, have a look at the various namespaces and use the live previews to explore the SDK. +SwiftUIKit started small, but has grown big over the years. Due to its complexity, I decided to remove the demo. Instead, have a look at the various namespaces and use the live previews to explore the SDK. -I will extract parts of this SDK into separate libraries, to be able to provide better documentation & help. Have a look at [my open-source listing page][OpenSource] for some of these. +I will extract parts of this project into separate libraries, to provide better documentation & help. Have a look at [my open-source listing page][OpenSource] for some of these. diff --git a/Sources/SwiftUIKit/SwiftUIKit.docc/SwiftUIKit.md b/Sources/SwiftUIKit/SwiftUIKit.docc/SwiftUIKit.md index 843099efcc..c47c3bc0ca 100644 --- a/Sources/SwiftUIKit/SwiftUIKit.docc/SwiftUIKit.md +++ b/Sources/SwiftUIKit/SwiftUIKit.docc/SwiftUIKit.md @@ -8,6 +8,8 @@ SwiftUIKit adds extra functionality to `SwiftUI`. ![SwiftUIKit logo](Logo.png) +SwiftUIKit is a Swift SDK that adds extra functionality to `SwiftUI` and `Swift`. It contains additional components, a lot of extensions to native types, and much more. + The library is divided into the namespaces found in the Topics section below. For more information, source code, issues, to sponsor the project etc., visit the [project repository][Repository]. @@ -24,6 +26,14 @@ If you prefer to not have external dependencies, you can also just copy the sour +## Getting Started + +SwiftUIKit started small, but has grown big over the years. Due to its complexity, I decided to remove the demo. Instead, have a look at the various namespaces and use the live previews to explore the SDK. + +I will extract parts of this SDK into separate libraries, to be able to provide better documentation & help. Have a look at [my open-source listing page][OpenSource] for some of these. + + + ## Repository For more information, source code, etc., visit the [project repository][Repository]. @@ -52,7 +62,9 @@ SwiftUIKit is available under the MIT license. See the [LICENSE][License] file f - ``CsvParser`` - ``MimeType`` - ``ScanCodeType`` -- ``StorageCodable`` +- ``StorageValue`` +- ``AppStorageValue`` +- ``SceneStorageValue`` ### Device @@ -128,7 +140,6 @@ SwiftUIKit is available under the MIT license. See the [LICENSE][License] file f - ``NavigationButton`` - ``NavigationContext`` - ``NavigationLinkArrow`` -- ``UrlOpener`` ### Pages @@ -211,3 +222,4 @@ SwiftUIKit is available under the MIT license. See the [LICENSE][License] file f [License]: https://github.com/danielsaidi/SwiftUIKit/blob/master/LICENSE [Repository]: https://github.com/danielsaidi/SwiftUIKit +[OpenSource]: https://danielsaidi.com/opensource