From 96ec321abf5f672fb61f92449bc3f22859af01d8 Mon Sep 17 00:00:00 2001 From: ThibaultKlein Date: Fri, 28 Apr 2017 16:08:46 -0400 Subject: [PATCH] Updated README and LICENSE --- LICENSE | 12 +++++------- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 48 insertions(+), 8 deletions(-) diff --git a/LICENSE b/LICENSE index 606e000..210e898 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,4 @@ -MIT License - -Copyright (c) 2017 Prolific Interactive +Copyright (c) 2017 Prolific Interactive. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -9,13 +7,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md index f0f8727..2948a8e 100644 --- a/README.md +++ b/README.md @@ -1 +1,43 @@ -# Kumi-iOS \ No newline at end of file +# Kumi-iOS + +[![Travis build status](https://img.shields.io/travis/prolificinteractive/Kumi-iOS.svg?style=flat-square)](https://travis-ci.org/prolificinteractive/Kumi-iOS) +[![Cocoapods Compatible](https://img.shields.io/cocoapods/v/Kumi.svg?style=flat-square)](https://img.shields.io/cocoapods/v/Kumi.svg) +[![Platform](https://img.shields.io/cocoapods/p/Kumi.svg?style=flat-square)](http://cocoadocs.org/docsets/Kumi) +[![Docs](https://img.shields.io/cocoapods/metrics/doc-percent/Kumi.svg?style=flat-square)](http://cocoadocs.org/docsets/Kumi) + +Kumi is an app's theme helper tool that can parse a JSON file generated from Sketch files. + +## Features + +`TODO` + +## Requirements + +* Xcode 8+ +* iOS 9+ + +## Installation + +Using Cocoapods: + +`pod Kumi` + +## Usage + +`TODO` + +## Contributing to Kumi + +To report a bug or enhancement request, feel free to file an issue under the respective heading. + +If you wish to contribute to the project, fork this repo and submit a pull request. **THE FOLLOWING SENTENCE IS FOR IOS SWIFT PROJECTS ONLY.** Code contributions should follow the standards specified in the [Prolific Swift Style Guide](https://github.com/prolificinteractive/swift-style-guide). + +## License + +![prolific](https://s3.amazonaws.com/prolificsitestaging/logos/Prolific_Logo_Full_Color.png) + +Copyright (c) 2017 Prolific Interactive + +Kumi is maintained and sponsored by Prolific Interactive. It may be redistributed under the terms specified in the [LICENSE] file. + +[LICENSE]: ./LICENSE \ No newline at end of file