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

Add documentation link to readme

This commit is contained in:
Daniel Saidi 2021-11-13 15:33:36 +01:00
parent a2bd714cbb
commit 91b96cb9f6
2 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -40,14 +40,6 @@ SwiftKit is divided into the following sections:
You can explore the various sections in the documentation or in the demo app. You can explore the various sections in the documentation or in the demo app.
## Demo App
This project contains a demo app that lets you explore `SwiftKit` through interactive demos.
The demo app provides an intuitive way to explore the library. Together with the extensive documentation and SwiftUI previews, I hope you'll find it easy to understand how the various parts of the library works.
To run the demo app, just open and run the `Demo/Demo.xcodeproj` project. It's a universal app project, but the `macOS` app is currenty not working that well.
## Installation ## Installation
@ -63,10 +55,27 @@ https://github.com/danielsaidi/SwiftKit.git
pod DSSwiftKit pod DSSwiftKit
``` ```
Note that you have to import `SwiftKit` with `import DSSwiftKit` if you add it with CocoaPods. The name `SwiftKit` was (not surprising) already taken.
## Contact me ## Documentation
The [SwiftKit documentation][Documentation] contains curated and structured information that makes it easy to overview the various parts of the library, see how the various parts connect to each other etc.
Just download the documentation, extract the zip file and double-tap the `SwiftKit.doccarchive` file to view the documentation directly in Xcode.
## Demo Application
This project contains a demo app that lets you explore `SwiftKit` through interactive demos.
The demo app provides an intuitive way to explore the library. Together with the extensive documentation and SwiftUI previews, I hope you'll find it easy to understand how the various parts of the library works.
To run the demo app, just open and run the `Demo/Demo.xcodeproj` project. It's a universal app project, but the `macOS` app is currenty not working that well.
## Contact
Feel free to reach out if you have questions or if you want to contribute in any way: Feel free to reach out if you have questions or if you want to contribute in any way:
@ -75,13 +84,15 @@ Feel free to reach out if you have questions or if you want to contribute in any
* Web site: [danielsaidi.com][Website] * Web site: [danielsaidi.com][Website]
## License ## License
SwiftKit is available under the MIT license. See [LICENSE][License] file for more info. SwiftKit is available under the MIT license. See [LICENSE][License] file for more info.
[Email]: mailto:daniel.saidi@gmail.com [Email]: mailto:daniel.saidi@gmail.com
[Twitter]: http://www.twitter.com/danielsaidi [Twitter]: http://www.twitter.com/danielsaidi
[Website]: http://www.danielsaidi.com [Website]: http://www.danielsaidi.com
[GitHub]: https://github.com/danielsaidi/SwiftKit [Documentation]: https://github.com/danielsaidi/SwiftKit/raw/master/Docs/SwiftKit.doccarchive.zip
[License]: https://github.com/danielsaidi/SwiftKit/blob/master/LICENSE [License]: https://github.com/danielsaidi/SwiftKit/blob/master/LICENSE

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

@ -9,7 +9,7 @@ SwiftKit adds extra functionality to the Swift framework, like extensions to nat
SwiftKit is divided into the sections found in the Topics section below. SwiftKit is divided into the sections found in the Topics section below.
You can explore the sections in the documentation or in the demo app. You can explore the sections in this documentation or in the demo app.
## Topics ## Topics