Skip to content

Commit

Permalink
Describe props
Browse files Browse the repository at this point in the history
  • Loading branch information
zalmoxisus committed Jan 20, 2016
1 parent e2d8164 commit 2bf6520
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ Also, it can be [used in React Native debugger as a dock monitor](https://github

In order to make it simple to use, by default, the module and the monitor app communicate via [remotedev.io](http://remotedev.io) server. Run it locally to make it faster and not to require an internet connection.

### Props

Name | Description
------------- | -------------
`name` | Instance name to be showed in the app.
`hostname` | If `port` is specified, default value is `localhost`.
`port` | Local host's port.

All props are optional. You have to provide at least `port` property to use `localhost` instead of `remotedev.io` server.

### Examples
- [Web](https://github.com/zalmoxisus/remote-redux-devtools/tree/master/examples)
- [React Native](https://github.com/zalmoxisus/react-native-counter-ios-android).
Expand Down

0 comments on commit 2bf6520

Please sign in to comment.