Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
danielsaidi committed Oct 6, 2024
1 parent a6111cb commit 67c1176
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
16 changes: 14 additions & 2 deletions Sources/SwiftUIKit/SwiftUIKit.docc/SwiftUIKit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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].


Expand All @@ -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].
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -128,7 +140,6 @@ SwiftUIKit is available under the MIT license. See the [LICENSE][License] file f
- ``NavigationButton``
- ``NavigationContext``
- ``NavigationLinkArrow``
- ``UrlOpener``

### Pages

Expand Down Expand Up @@ -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

0 comments on commit 67c1176

Please sign in to comment.