Skip to content

Commit 84f560e

Browse files
Update README.md
1 parent 58388b0 commit 84f560e

File tree

1 file changed

+48
-2
lines changed

1 file changed

+48
-2
lines changed

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# rxjava-android
1+
# RxAndroid: Reactive Extensions for Android
22

3-
Android specific bindings for Rx.
3+
Android specific bindings for [RxJava](http://github.com/ReactiveX/RxJava).
44

55
This module adds a number of classes to RxJava that make writing reactive components in
66
Android applications easy and hassle free. More specifically, it
@@ -10,6 +10,17 @@ Android applications easy and hassle free. More specifically, it
1010
`Fragment` and `Activity` life-cycle callbacks (coming soon)
1111
- provides reusable, self-contained reactive components for common Android use cases and UI concerns (coming soon)
1212

13+
## Master Build Status
14+
15+
<a href='https://travis-ci.org/ReactiveX/RxAndroid/builds'><img src='https://travis-ci.org/ReactiveX/RxAndroid.svg?branch=0.x'></a>
16+
17+
## Communication
18+
19+
Since RxGroovy is part of the RxJava family the communication channels are similar:
20+
21+
- Google Group: [RxJava](http://groups.google.com/d/forum/rxjava)
22+
- Twitter: [@RxJava](http://twitter.com/RxJava)
23+
- [GitHub Issues](https://github.com/ReactiveX/RxAndroid/issues)
1324

1425
# Binaries
1526

@@ -31,6 +42,19 @@ and for Ivy:
3142
<dependency org="com.netflix.rxjava" name="rxjava-android" rev="0.10.1" />
3243
```
3344

45+
## Build
46+
47+
To build:
48+
49+
```
50+
$ git clone git@github.com:ReactiveX/RxAndroid.git
51+
$ cd RxAndroid/
52+
$ ./RxAndroid build
53+
```
54+
55+
Futher details on building can be found on the RxJava [Getting Started](https://github.com/ReactiveX/RxJava/wiki/Getting-Started) page of the wiki.
56+
57+
3458
# Sample usage
3559

3660
We are working on a samples project which provides runnable code samples that demonstrate common Rx patterns and
@@ -78,3 +102,25 @@ scheduler:
78102
This will execute the Observable on a new thread and emit results through `onNext` on "custom-thread-1".
79103
(This example is contrived since you could as well call `observeOn(Schedulers.currentThread())` but it
80104
shall suffice to illustrate the idea.)
105+
106+
107+
## Bugs and Feedback
108+
109+
For bugs, questions and discussions please use the [Github Issues](https://github.com/ReactiveX/RxAndroid/issues).
110+
111+
112+
## LICENSE
113+
114+
Licensed under the Apache License, Version 2.0 (the "License");
115+
you may not use this file except in compliance with the License.
116+
You may obtain a copy of the License at
117+
118+
<http://www.apache.org/licenses/LICENSE-2.0>
119+
120+
Unless required by applicable law or agreed to in writing, software
121+
distributed under the License is distributed on an "AS IS" BASIS,
122+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
123+
See the License for the specific language governing permissions and
124+
limitations under the License.
125+
126+

0 commit comments

Comments
 (0)