From f6ecc8da7bbdffda308cf2e7aa4c9213d0325836 Mon Sep 17 00:00:00 2001 From: Robert Spencer Date: Tue, 7 Mar 2017 06:51:04 -0800 Subject: [PATCH] Update readme with badges and YogaLayout badges Summary: This adds bintray badges to the readme, and creates a readme for the android code. Reviewed By: emilsjolander Differential Revision: D4666314 fbshipit-source-id: a2549374f3e9c39c260160d1e32fb37801ff4208 --- README.md | 3 ++- android/README.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 android/README.md diff --git a/README.md b/README.md index 7f0ac12a..26580e17 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Yoga [![CocoaPods](https://img.shields.io/cocoapods/v/YogaKit.svg)](http://cocoapods.org/pods/YogaKit) [![npm](https://img.shields.io/npm/v/yoga-layout.svg)](https://www.npmjs.com/package/yoga-layout) +# Yoga [![CocoaPods](https://img.shields.io/cocoapods/v/YogaKit.svg)](http://cocoapods.org/pods/YogaKit) [![npm](https://img.shields.io/npm/v/yoga-layout.svg)](https://www.npmjs.com/package/yoga-layout) [![bintray](https://img.shields.io/bintray/v/facebook/maven/com.facebook.yoga:yoga.png)](https://bintray.com/facebook/maven/com.facebook.yoga%3Ayoga/_latestVersion) [![C Status](https://badges.herokuapp.com/travis/facebook/yoga?env=TARGET=c&label=C)](https://travis-ci.org/facebook/yoga) [![Java Status](https://badges.herokuapp.com/travis/facebook/yoga?env=TARGET=java&label=Java)](https://travis-ci.org/facebook/yoga) @@ -7,6 +7,7 @@ [![JavaScript Status](https://badges.herokuapp.com/travis/facebook/yoga?env=TARGET=js&label=JavaScript)](https://travis-ci.org/facebook/yoga) [![Android Status](https://badges.herokuapp.com/travis/facebook/yoga?env=TARGET=android&label=Android)](https://travis-ci.org/facebook/yoga) + ## Building Yoga builds with [buck](https://buckbuild.com). Make sure you install buck before contributing to Yoga. Yoga's main implementation is in C, with bindings to supported languages and frameworks. When making changes to Yoga please ensure the changes are also propagated to these bindings when applicable. diff --git a/android/README.md b/android/README.md new file mode 100644 index 00000000..af9a0787 --- /dev/null +++ b/android/README.md @@ -0,0 +1,21 @@ +# YogaLayout [![Platform](https://img.shields.io/badge/platforms-Android-orange.svg)](https://facebook.github.io/yoga/docs/api/android/) [![Languages](https://img.shields.io/badge/languages-Java-orange.svg)](https://facebook.github.io/yoga/docs/api/android/) [![Download](https://img.shields.io/bintray/v/facebook/maven/com.facebook.yoga.android:yoga-layout.png)](https://bintray.com/facebook/maven/com.facebook.yoga.android%3Ayoga-layout/_latestVersion) + +## Installation + +YogaLayout is available via jcenter: + + compile 'com.facebook.yoga.android:yoga-layout:1.2.0' + +## Getting Started + +Check out the docs [here](https://facebook.github.io/yoga/docs/api/android/). + +We also have a sample project. To try it, clone the repo and run (with a device attached) + + buck install -r android/sample + +## 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 file for how to help out.