aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKirk Shoop <kirk.shoop@gmail.com>2018-05-04 11:03:54 -0700
committerGitHub <noreply@github.com>2018-05-04 11:03:54 -0700
commit7cebbd4d2b3ac16249d538024e7f31eaa300c962 (patch)
tree80e8ce9f6ad2b3c115a627837daac126101ce58a
parent76149330a666200b62422454a4fd8d3cd0a4ae37 (diff)
downloadplatform_external_Reactive-Extensions_RxCpp-7cebbd4d2b3ac16249d538024e7f31eaa300c962.tar.gz
platform_external_Reactive-Extensions_RxCpp-7cebbd4d2b3ac16249d538024e7f31eaa300c962.tar.bz2
platform_external_Reactive-Extensions_RxCpp-7cebbd4d2b3ac16249d538024e7f31eaa300c962.zip
Update README.md
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8106c4a..dbeaaab 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,12 @@ Gitter.im | [![Join in on gitter.im](https://img.shields.io/gitter/room/Reactive
Packages | [![NuGet version](http://img.shields.io/nuget/v/RxCpp.svg?style=flat-square)](http://www.nuget.org/packages/RxCpp/) [![vcpkg port](https://img.shields.io/badge/vcpkg-port-blue.svg?style=flat-square)](https://github.com/Microsoft/vcpkg/tree/master/ports/rxcpp)
Documentation | [![rxcpp doxygen documentation](https://img.shields.io/badge/rxcpp-latest-brightgreen.svg?style=flat-square)](http://reactive-extensions.github.io/RxCpp) <br/> [![reactivex intro](https://img.shields.io/badge/reactivex.io-intro-brightgreen.svg?style=flat-square)](http://reactivex.io/intro.html) [![rx marble diagrams](https://img.shields.io/badge/rxmarbles-diagrams-brightgreen.svg?style=flat-square)](http://rxmarbles.com/)
+# Usage
+
+__RxCpp__ is a header-only C++ library that only depends on the standard library. The CMake build generates documentation and unit tests.
+
# Example
-Add ```Rx/v2/src``` to the include paths
+Add `Rx/v2/src` to the include paths
[![lines from bytes](https://img.shields.io/badge/blog%20post-lines%20from%20bytes-blue.svg?style=flat-square)](http://kirkshoop.github.io/async/rxcpp/c++/2015/07/07/rxcpp_-_parsing_bytes_to_lines_of_text.html)
@@ -230,7 +234,5 @@ When Doxygen+Graphviz is installed, CMake creates a special build task named `do
Before submitting a feature or substantial code contribution please discuss it with the team and ensure it follows the product roadmap. Note that all code submissions will be rigorously reviewed and tested by the Rx Team, and only those that meet an extremely high bar for both quality and design/roadmap appropriateness will be merged into the source.
-You will be prompted to submit a Contributor License Agreement form after submitting your pull request. This needs to only be done once for any Microsoft OSS project. Fill in the [Contributor License Agreement](https://cla2.msopentech.com/) (CLA).
-
# Microsoft Open Source Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.