Readme (cadence-workflow#10)

LICENSE

@@ -0,0 +1,20 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// 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 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.
+

README.md

@@ -1,2 +1,27 @@
-## Documentation
-To learn how to document your project on [EngDocs](https://engdocs.uberinternal.com), see this [guide](https://engdocs.uberinternal.com/engdocs/index.html).
+cadence 
+==============
+[Cadence](https://eng.uber.com/) is awesome!
+
+Developing
+----------
+
+Prerequisite:
+* Make certain that `thrift` is in your path. (OSX: `brew install thrift`) 
+* `thrift-gen` is needed (`go get github.com/uber/tchannel-go/thrift/thrift-gen`)
+* `cassandra` 3.9 is needed to run tests (OSX: `brew install cassandra`)
+
+After starting cassandra, run `make` to build
+
+Contributing
+------------
+We'd love your help in making Cadence great. If you need new API(s) to be added to our thrift files, open an issue and we will respond as fast as we can. If you want to propose new feature(s) along with the appropriate APIs yourself, open a pull request to start a discussion and we will merge it after review.
+
+**Note:** All contributors also need to fill out the [Uber Contributor License Agreement](http://t.uber.com/cla) before we can merge in any of your changes
+
+Documentation
+--------------
+Interested in learning more about Cadence? TODO:
+
+License
+-------
+MIT License, please see [LICENSE](https://github.com/uber/cadence/blob/master/LICENSE) for details.