From c217553cf8d12312bc4deeee6d373160314496fa Mon Sep 17 00:00:00 2001 From: Dustin Shahidehpour Date: Mon, 30 Jan 2017 11:04:22 -0800 Subject: [PATCH] Add README.md Summary: This gives YogaKit its' own readme. #accept2ship Reviewed By: emilsjolander Differential Revision: D4482411 fbshipit-source-id: 24ddab586d9a12a8419ae8811fa4d03b27c1a19e --- YogaKit/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 YogaKit/README.md 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.