Merge pull request #4 from uber/opensource

Add open source documents

Author: neakor

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to Swift-Concurrency
+
+Uber welcomes contributions of all kinds and sizes. This includes everything from from simple bug reports to large features.
+
+Before we can accept your contributions, we kindly ask you to sign our [Contributor License Agreement](https://cla-assistant.io/uber/RIBs).
+
+Workflow
+--------
+
+We love GitHub issues!
+
+For small feature requests, an issue first proposing it for discussion or demo implementation in a PR suffice.
+
+For big features, please open an issue so that we can agree on the direction, and hopefully avoid investing a lot of time on a feature that might need reworking.
+
+Small pull requests for things like typos, bug fixes, etc are always welcome.
+
+DOs and DON'Ts
+--------------
+
+* DO follow our [coding style](https://github.com/raywenderlich/swift-style-guide) 
+* DO include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
+* DO keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion.
+
+* DON'T submit PRs that alter licensing related files or headers. If you believe there's a problem with them, file an issue and we'll be happy to discuss it.
+
+Guiding Principles
+------------------
+
+* We allow anyone to participate in our projects. Tasks can be carried out by anyone that demonstrates the capability to complete them
+* Always be respectful of one another. Assume the best in others and act with empathy at all times
+* Collaborate closely with individuals maintaining the project or experienced users. Getting ideas out in the open and seeing a proposal before it's a pull request helps reduce redundancy and ensures we're all connected to the decision making process

README.md

@@ -1,4 +1,19 @@
-# Swift Concurrency Utility Classes
+# Swift Concurrency
+
+## Contents
+
+- [Requirements](#requirements)
+- [Overview](#overview)
+- [Installation](#installation)
+- [Building](#building)
+- [Testing](#testing)
+
+## Requirements
+
+- Xcode 9.3+
+- Swift 4.0+
+
+## Overview
 
 A set of concurrency utility classes used by Uber. These are largely inspired by the equivalent [java.util.concurrent](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/package-summary.html) package classes.
 
@@ -13,3 +28,58 @@ Provides locking-free synchronization of a mutable object reference. It provides
 
 ### `CountDownLatch`
 A utility class that allows coordination between threads. A count down latch starts with an initial count. Threads can then decrement the count until it reaches zero, at which point, the suspended waiting thread shall proceed. A `CountDownLatch` behaves differently from a `DispatchSemaphore` once the latch is open. Unlike a semaphore where subsequent waits would still block the caller thread, once a `CountDownLatch` is open, all subsequent waits can directly passthrough.
+
+## Installation
+
+### Carthage
+
+[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with dylib frameworks.
+
+You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
+
+```bash
+$ brew update
+$ brew install carthage
+```
+
+To integrate Swift-Concurrency into your Xcode project using Carthage, specify it in your `Cartfile`:
+
+```ogdl
+github "https://github.com/uber/swift-concurrency.git" ~> 0.2.0
+```
+
+Run `carthage update` to build the framework and add the built `Concurrency.framework` into your Xcode project, by following the [instructions](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application)
+
+### Manually
+
+If you prefer not to use Carthage, you can integrate Swift-Concurrency into your project manually, by adding the source files.
+
+## Building
+
+First fetch the dependencies:
+
+```bash
+$ swift package fetch
+```
+
+You can then build from the command-line:
+
+```bash
+$ swift build
+```
+
+Or create an Xcode project and build using the IDE:
+
+```bash
+$ swift package generate-xcodeproj
+```
+
+## Testing
+
+From command-line.
+
+```bash
+$ swift test
+```
+
+Or you can follow the steps above to generate a Xcode project and run tests within Xcode.

travis.yml

@@ -0,0 +1,10 @@
+language: objective-c
+osx_image: xcode9
+
+env:
+  - ACTION=test  PLATFORM=Mac     DESTINATION='platform=OS X'
+  - ACTION=test  PLATFORM=iOS     DESTINATION='platform=iOS Simulator,name=iPhone 7'
+  - ACTION=test  PLATFORM=tvOS    DESTINATION='platform=tvOS Simulator,name=Apple TV 1080p'
+
+script:
+  - swift test