dnrops
/
SwiftKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

This commit is contained in:
Daniel Saidi 2023-06-12 13:51:32 +02:00
parent 4913287915
commit 6f74774953
2 changed files with 20 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -6,8 +6,12 @@
<img src="https://img.shields.io/github/v/release/danielsaidi/SwiftKit?color=%2300550&sort=semver" alt="Version" /> <img src="https://img.shields.io/github/v/release/danielsaidi/SwiftKit?color=%2300550&sort=semver" alt="Version" />
<img src="https://img.shields.io/badge/Swift-5.6-orange.svg" alt="Swift 5.6" /> <img src="https://img.shields.io/badge/Swift-5.6-orange.svg" alt="Swift 5.6" />
<img src="https://img.shields.io/github/license/danielsaidi/SwiftKit" alt="MIT License" /> <img src="https://img.shields.io/github/license/danielsaidi/SwiftKit" alt="MIT License" />
<img src="https://img.shields.io/twitter/url?label=Twitter&style=social&url=https%3A%2F%2Ftwitter.com%2Fdanielsaidi" alt="Twitter: @danielsaidi" title="Twitter: @danielsaidi" /> <a href="https://twitter.com/danielsaidi">
<img src="https://img.shields.io/mastodon/follow/000253346?label=mastodon&style=social" alt="Mastodon: @danielsaidi@mastodon.social" title="Mastodon: @danielsaidi@mastodon.social" /> <img src="https://img.shields.io/twitter/url?label=Twitter&style=social&url=https%3A%2F%2Ftwitter.com%2Fdanielsaidi" alt="Twitter: @danielsaidi" title="Twitter: @danielsaidi" />
</a>
<a href="https://mastodon.social/@danielsaidi">
<img src="https://img.shields.io/mastodon/follow/000253346?label=mastodon&style=social" alt="Mastodon: @danielsaidi@mastodon.social" title="Mastodon: @danielsaidi@mastodon.social" />
</a>
</p> </p>
@ -25,36 +29,20 @@ SwiftKit can be installed with the Swift Package Manager:
https://github.com/danielsaidi/SwiftKit.git https://github.com/danielsaidi/SwiftKit.git
``` ```
or with CocoaPods:
```
pod DSSwiftKit
```
If you prefer to not have external dependencies, you can also just copy the source code into your app. If you prefer to not have external dependencies, you can also just copy the source code into your app.
## Supported Platforms
SwiftKit supports `iOS 13`, `macOS 11`, `tvOS 13` and `watchOS 6`.
## Documentation ## Documentation
You can use the [online documentation][Documentation] to overview the various parts of the library. The [online documentation][Documentation] has more information, code examples, etc., and makes it easy to overview the various parts of the library.
## Demo Application
The demo app lets you explore the library on iOS and macOS. To try it out, just open and run the `Demo` project.
## Support ## Support
I manage my various open-source projects in my free time and am really thankful for any help I can get from the community.
You can sponsor this project on [GitHub Sponsors][Sponsors] or get in touch for paid support. You can sponsor this project on [GitHub Sponsors][Sponsors] or get in touch for paid support.
@ -70,6 +58,12 @@ Feel free to reach out if you have questions or if you want to contribute in any
## Supported Platforms
SwiftKit supports `iOS 13`, `macOS 11`, `tvOS 13` and `watchOS 6`.
## License ## License
SwiftKit is available under the MIT license. See the [LICENSE][License] file for more info. SwiftKit is available under the MIT license. See the [LICENSE][License] file for more info.

27
Sources/SwiftKit/SwiftKit.docc/SwiftKit.md
View File

@ -1,13 +1,16 @@
# ``SwiftKit`` # ``SwiftKit``
SwiftKit adds extra functionality to the Swift framework, like extensions to native types, utilites, services etc. SwiftKit adds extra functionality to the Swift programming language.
## Overview ## Overview
![SwiftKit logo](Logo.png) ![SwiftKit logo](Logo.png)
SwiftKit is divided into the sections found in the Topics section below. The online documentation is currently iOS-specific. To generate documentation for other platforms, open the package in Xcode, select a simulator then run `Product/Build Documentation`.
The library is divided into the namespaces found in the Topics section below. For more information, source code, an if you want to report issues, sponsor the project etc., visit the [project repository](https://github.com/danielsaidi/SwiftKit).
@ -19,30 +22,10 @@ SwiftKit can be installed with the Swift Package Manager:
https://github.com/danielsaidi/SwiftKit.git https://github.com/danielsaidi/SwiftKit.git
``` ```
or with CocoaPods:
```
pod DSSwiftKit
```
If you prefer to not have external dependencies, you can also just copy the source code into your app. If you prefer to not have external dependencies, you can also just copy the source code into your app.
## Supported Platforms
SwiftKit supports `iOS 13`, `macOS 11`, `tvOS 13` and `watchOS 6`.
## About this documentation
The online documentation is currently iOS-specific. To generate documentation for other platforms, open the package in Xcode, select a simulator then run `Product/Build Documentation`.
Note that type extensions are not included in this documentation.
## License ## License
SwiftKit is available under the MIT license. SwiftKit is available under the MIT license.