Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README.md

  • Loading branch information...
commit 56968a8da3856b290155c4fe279eea37b350c903 1 parent 8bd153a
Paolo Fragomeni authored
Showing with 13 additions and 4 deletions.
  1. +13 −4 README.md
View
17 README.md
@@ -4,18 +4,27 @@ An interactive representation of an object for the CLI similar to that of consol
# Motivation
Why? Sometimes you have a lot of data that gets dumped to the screen. It's hard to keep track of it visually. A lot of the time you are just looking for one item in a sea of data. Progressive disclosure helps.
+# Features
+ - Searchable/Repeat search
+ - Handles cyclical references
+ - Expand and collapse nodes like webkit console.dir()
+ -
+
# Usage
+## Installation
+Require the module in your program like this `console.dir = require('cdir')`.
+
## Navigation
-First, require the module. Then use `console.dir(somecode)` in your program and then use `tab` or `shift+tab` to cycle through the object's members. You can hit `space`, `return` or `enter` to expand a member. See the example below.
+Use `console.dir(someobject)` somewhere in your program and use `tab` or `shift+tab` to cycle through the object's members. You can hit `space`, `return` or `enter` to expand a member. See the example below.
-## Searching throught JSON
+## Searching
Search by pressing the `/` key. This will display a `/` prompt. If you have already searched for something it will be displayed before the `/` prompt. For instance if you searched for "foobar" it would appear as `(foobar) /`.
-## How to quit
+## Quitting
Hit `ctrl+c` or `q` to quit!
-## An example
+## Simple Example
There is a CLI version too if you want to use it. `npm install cdir -g`.
```js
Please sign in to comment.
Something went wrong with that request. Please try again.