From 010656952b9f736857374316084fe82dce56c492 Mon Sep 17 00:00:00 2001 From: Jed Watson Date: Mon, 6 Mar 2017 17:09:43 +1100 Subject: [PATCH] Adding intro + credits to Readme --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d871bc1..e74d293 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ # React Conf 2017 -React native event schedule app +The companion app for [React Conf 2017](http://conf.reactjs.org) in Santa Clara, California. Powered by [React Native](https://facebook.github.io/react-native/), and built in Sydney by [Thinkmill](https://www.thinkmill.com.au). + +Get a live schedule, information about the talks and speakers, and easily tweet or share talks as they happen. + +## About the App + +We're open sourcing this early as a preview, it's been submitted to the app store and will hopefully be available in a couple of days. We'll add a link to the app here when that happens. + +There will be design tweaks and updates as we lead up to the conference - we'll also be publishing the final Sketch files when they're ready. + +PRs and feedback are welcome, let us know what you think! + +And for those of you who will be attending, we hope you enjoy the app, and we'll see you there. + +## Getting Started + +To run the app, clone this repo then use `yarn` to install its dependencies. + +Open the project in XCode and click "Play". You should be good to go! + +## Credits + +[Thinkmill](https://www.thinkmill.com.au) set aside some project time to build this app because we wanted to hack on a fresh React Native project, try some new things and we're excited about the conference. + +The following people made it happen: + +* [Boris Bozic](https://twitter.com/borisbozic) - Design +* [Jed Watson](http://twitter.com/jedwatson) - Concept and Architecture +* [Joss Mackison](https://twitter.com/jossmackison) - UI +* [Kevin Brown](https://github.com/blargity) - Programming + +Also thanks to [James Kyle](https://twitter.com/thejameskyle) for his review & contributions. + +We've incorporated some cool tech including: + +* [Code Push](http://microsoft.github.io/code-push/) +* [Jest](https://facebook.github.io/jest/) +* [Flow](https://flowtype.org) +* [Prettier](https://github.com/prettier/prettier) + +See [package.json](./package.json) for the full set of react native packages we used. + +# License + +MIT Licensed. Copyright (c) Thinkmill Pty Ltd 2017.