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

= Readme - Improve readability #19

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

= Readme - Improve readability #19

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
22 changes: 14 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,21 @@ Pure vanilla-js ultra-lightweight dom inspector similiar to built-in tool in chr

## Install

yarn add inspector-dom
### NPM
`npm i -s inspector-dom`

`const Inspector = require('inspector-dom')`

`import Inspector from 'inspector-dom'`
### Yarn
`yarn add inspector-dom`

## Usage

Initialize:

`const inspector = Inspector()`
```js

import Inspector from 'inspector-dom';

const inspector = Inspector();
```

Props:

Expand All @@ -30,6 +34,8 @@ const inspector = Inspector({

## API

`inspector.enable() // turn the inspector on`
```js
inspector.enable() // turn the inspector on

`inspector.cancel() // turn the inspector off`
inspector.cancel() // turn the inspector off
```