diff --git a/README.md b/README.md index 9f8e1ba..5bbe865 100644 --- a/README.md +++ b/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 = () => ( @@ -35,23 +45,14 @@ const App = () => ( onPress={show} /> -) -``` +); -```javascript -import { - DevTool, - log, - network, -} from 'react-native-debug-console'; - -network.attach(); -log.attach(); - -const App = () => ( +const AppWithComponent = () => ( -) -``` \ No newline at end of file +); +``` + +Both `DevTool` and `DevToolModal` has a `includeStackTrace` property, which if set will print the stack trace on errors, not just the error message. `` \ No newline at end of file diff --git a/lib/package.json b/lib/package.json index 4eb3c97..5790702 100644 --- a/lib/package.json +++ b/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": { diff --git a/package.json b/package.json index 1e39f63..e27d139 100644 --- a/package.json +++ b/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",