diff --git a/YogaKit/README.md b/YogaKit/README.md new file mode 100644 index 00000000..75d6bff2 --- /dev/null +++ b/YogaKit/README.md @@ -0,0 +1,22 @@ +# YogaKit + +[![Cocoapods](https://img.shields.io/cocoapods/v/YogaKit.svg?style=flat)](https://cocoapods.org/pods/YogaKit) +[![Platform](https://img.shields.io/badge/platforms-iOS-orange.svg)](https://facebook.github.io/yoga/docs/api/yogakit/) +[![Languages](https://img.shields.io/badge/languages-ObjC%20%7C%20Swift-orange.svg)](https://facebook.github.io/yoga/docs/api/yogakit/) + +## Installation +YogaKit is available to install via [Cocoapods](https://cocoapods.org/). + +``` +pod 'YogaKit', '~> 1.0.2' +``` + +## Getting Started +Checkout the docs [here](https://facebook.github.io/yoga/docs/api/yogakit/). + +We also have a sample project. To try it out, clone this repo and open `YogaKitSample.xcodeproj` in the [YogaKitSample](https://github.com/facebook/yoga/tree/master/YogaKit/YogaKitSample) directory. + +## Contributing +We welcome all pull-requests! At Facebook we sync the open source version of `YogaKit` daily, so we're always testing the latest changes. + +See the [CONTRIBUTING](https://github.com/facebook/yoga/blob/master/CONTRIBUTING) file for how to help out.