Updated readme

README.md

@@ -1,8 +1,10 @@
 # React Native Debug Console
 
-A network and console debug component and modal for `react native` purely in JavaScript
+... and yes I am aware that it is a boring name
 
-[[demo]](https://expo.io/@mortenolsen/demo) [[snack]](https://snack.expo.io/@mortenolsen/react-native-debug-console)
+React Native Debug Console is an easy to use network and console debug component and modal for react native, written purely in JavaScript
+
+[[demo]](https://expo.io/@mortenolsen/demo)
 
 ![screen](docs/assets/screen1.PNG)
 
@@ -14,20 +16,28 @@ npm install react-native-debug-console
 
 ## Usage
 
-It comes as a ready to use modal, as well as a standalone component
+In order to redirect console logs and network logs to the console, these has to be attached
 
 ```javascript
 import {
+  DevTool,
   DevToolModal,
   log,
   network,
-  show,
 } from 'react-native-debug-console';
 
 network.attach();
 log.attach();
 
-const App = () => (
+```
+
+Be aware that this stops logs to be output to the regular console.
+If that is needed, attach it as `log.attach(true)`
+
+`react-native-debug-console` can be used either as a modal, or as a standard component, which can be placed anywhere in you application
+
+```javascript
+const AppWithModal = () => (
   <View>
     <MyOtherContent />
     <DevToolModal />
@@ -35,23 +45,14 @@ const App = () => (
       onPress={show}
     />
   </View>
-)
+);
-```
 
-```javascript
+const AppWithComponent = () => (
-import {
-  DevTool,
-  log,
-  network,
-} from 'react-native-debug-console';
-
-network.attach();
-log.attach();
-
-const App = () => (
   <View>
     <MyOtherContent />
     <DevTool />
   </View>
-)
+);
 ```
+
+Both `DevTool` and `DevToolModal` has a `includeStackTrace` property, which if set will print the stack trace on errors, not just the error message. `<DevTool includeStackTrace />`

lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-debug-console",
-  "version": "1.0.0-beta.7",
+  "version": "1.0.0-beta.8",
   "main": "src/index.js",
   "license": "MIT",
   "dependencies": {

package.json

@@ -2,6 +2,9 @@
   "name": "debugger",
   "version": "1.0.0",
   "main": "index.js",
+  "repository": {
+    "url": "https://github.com/morten-olsen/react-native-debugger",
+  },
   "license": "MIT",
   "devDependencies": {
     "create-react-native-app": "^1.0.0",