Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix README.md format #40

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix README.md format #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ It generates and weaves code based on annotations only on ```debug``` versions o
![frodo_hug](https://cloud.githubusercontent.com/assets/1360604/10925718/e7ea4318-8290-11e5-91b4-f2bfbde65319.gif)

<br>

Main Features
-----------------

Expand All @@ -26,6 +27,7 @@ Main Features
}
```
<br>

- **@RxLogObservable.Scope Options:** It is possible to narrow down the debug information shown by adding a debugging scope to @RxLogObservable annotation.

- **Scope.EVERYTHING:** Logs stream data, schedulers and rx.Observable events. Default.
Expand All @@ -42,6 +44,7 @@ Main Features
```

<br>

- **@RxLogSubscriber:** Annotated classes which are of type ```rx.Subscriber``` will print the following information when receiving items from an ```rx.Observable```:

<img width="980" alt="frodo_subscriber" src="https://cloud.githubusercontent.com/assets/1360604/10925010/fa76523e-828a-11e5-8607-1611aef61add.png">
Expand Down Expand Up @@ -75,6 +78,7 @@ public class MySubscriberBackpressure extends Subscriber<Integer> {
```

<br>

Enabling Frodo
-----------------
To enable Frodo, a gradle plugin must be applied in your ```build.gradle```:
Expand All @@ -100,6 +104,7 @@ frodo {
```

<br>

Known issues
-----------------

Expand All @@ -112,6 +117,7 @@ android {
```

<br>

Frodo WIKI
-----------------
For complete information, features and usage, refer to the [WIKI](https://github.com/android10/frodo/wiki):
Expand All @@ -122,6 +128,7 @@ For complete information, features and usage, refer to the [WIKI](https://github
- [Frodo under the hoods](https://github.com/android10/frodo/wiki/Under-the-hoods)

<br>

License
-----------------

Expand Down