Adjust documentation
This commit is contained in:
Daniel Saidi
parent
86753bf3ed
commit
68d7bcd272
45
README.md
45
README.md
|
|
@ -1,29 +1,20 @@
|
|||
<p align="center">
|
||||
<img src ="Resources/Logo.png" width=500 alt="SwiftKit Logo" title="SwiftKit" />
|
||||
<img src ="Resources/Logo.png" alt="SwiftKit Logo" title="SwiftKit" width=600 />
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/github/v/release/danielsaidi/SwiftKit?color=%2300550&sort=semver" alt="Version" />
|
||||
<img src="https://img.shields.io/badge/platform-SwiftUI-red.svg" alt="Swift UI" />
|
||||
<img src="https://img.shields.io/badge/Swift-5.6-orange.svg" alt="Swift 5.6" />
|
||||
<img src="https://img.shields.io/badge/platform-SwiftUI-blue.svg" alt="Swift UI" title="Swift UI" />
|
||||
<img src="https://img.shields.io/github/license/danielsaidi/SwiftKit" alt="MIT License" />
|
||||
<a href="https://twitter.com/danielsaidi">
|
||||
<img src="https://img.shields.io/badge/contact-@danielsaidi-blue.svg?style=flat" alt="Twitter: @danielsaidi" />
|
||||
</a>
|
||||
<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" />
|
||||
<img src="https://img.shields.io/mastodon/follow/000253346?label=mastodon&style=social" alt="Mastodon: @danielsaidi@mastodon.social" title="Mastodon: @danielsaidi@mastodon.social" />
|
||||
</p>
|
||||
|
||||
|
||||
## About SwiftKit
|
||||
|
||||
SwiftKit adds extra functionality to the Swift programming language, like extensions to already existing types as well as completely new utilites, services, etc.
|
||||
|
||||
You can explore the various sections in the [documentation][Documentation] and the demo app.
|
||||
|
||||
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
SwiftKit supports `iOS 13`, `macOS 11`, `tvOS 13` and `watchOS 6`.
|
||||
SwiftKit adds extra functionality to the Swift programming language, like extensions to already existing types as well as completely new stuff.
|
||||
|
||||
|
||||
|
||||
|
|
@ -41,21 +32,25 @@ or with CocoaPods:
|
|||
pod DSSwiftKit
|
||||
```
|
||||
|
||||
You can also clone the repository and build the library locally.
|
||||
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
|
||||
|
||||
The [online documentation][Documentation] has articles, code examples etc. that let you overview the various parts of the library.
|
||||
|
||||
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`.
|
||||
You can use the [online documentation][Documentation] to overview the various parts of the library.
|
||||
|
||||
|
||||
|
||||
## Demo Application
|
||||
|
||||
This project has a demo app that lets you explore the library on iOS and macOS. To try it out, just open and run `Demo/Demo.xcodeproj`.
|
||||
The demo app lets you explore the library on iOS and macOS. To try it out, just open and run the `Demo` project.
|
||||
|
||||
|
||||
|
||||
|
|
@ -69,20 +64,22 @@ You can sponsor this project on [GitHub Sponsors][Sponsors] or get in touch for
|
|||
|
||||
Feel free to reach out if you have questions or if you want to contribute in any way:
|
||||
|
||||
* E-mail: [daniel.saidi@gmail.com][Email]
|
||||
* Website: [danielsaidi.com][Website]
|
||||
* Mastodon: [@danielsaidi@mastodon.social][Mastodon]
|
||||
* Twitter: [@danielsaidi][Twitter]
|
||||
* Web site: [danielsaidi.com][Website]
|
||||
* E-mail: [daniel.saidi@gmail.com][Email]
|
||||
|
||||
|
||||
|
||||
## License
|
||||
|
||||
SwiftKit is available under the MIT license. See [LICENSE][License] file for more info.
|
||||
SwiftKit is available under the MIT license. See the [LICENSE][License] file for more info.
|
||||
|
||||
|
||||
[Email]: mailto:daniel.saidi@gmail.com
|
||||
[Twitter]: http://www.twitter.com/danielsaidi
|
||||
[Website]: http://www.danielsaidi.com
|
||||
[Website]: https://www.danielsaidi.com
|
||||
[Twitter]: https://www.twitter.com/danielsaidi
|
||||
[Mastodon]: https://mastodon.social/@danielsaidi
|
||||
[Sponsors]: https://github.com/sponsors/danielsaidi
|
||||
|
||||
[Documentation]: https://danielsaidi.github.io/SwiftKit/documentation/swiftkit/
|
||||
|
|
|
|||
|
|
@ -25,6 +25,7 @@ public class StandardCsvParser: CsvParser {
|
|||
}
|
||||
|
||||
private let fileManager: FileManager
|
||||
|
||||
|
||||
/**
|
||||
Parse a csv file in a certain bundle.
|
||||
|
|
|
|||
|
|
@ -11,12 +11,6 @@ SwiftKit is divided into the sections found in the Topics section below.
|
|||
|
||||
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
SwiftKit supports `iOS 13`, `macOS 11`, `tvOS 13` and `watchOS 6`.
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
SwiftKit can be installed with the Swift Package Manager:
|
||||
|
|
@ -31,7 +25,13 @@ or with CocoaPods:
|
|||
pod DSSwiftKit
|
||||
```
|
||||
|
||||
You can also clone the repository and build the library locally.
|
||||
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`.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue