Skip to content

Commit

Permalink
Improve the README a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
johan committed Sep 30, 2015
1 parent 3306cc2 commit 217dcb3
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
QuickJSON
=========

A QuickLook plugin to pretty-print (node.js style) JSON.
A QuickLook plugin to pretty-print JSON in the terse comma-first style, e g:

```json
{ "name": "flux"
, "description": "An application architecture based on a unidirectional data flow"
, "version": "2.1.1"
, "homepage": "http://facebook.github.io/flux/"
, "repository":
{ "type": "git"
, "url": "https://github.com/facebook/flux.git"
}
, "authors":
[ "Facebook"
, "Jing Chen <[email protected]>"
, "Bill Fisher <[email protected]>"
, "Paul O'Shannessy <[email protected]>"
]
}
```

### Installing

To install a pre-built version for osx 10.6+,
download and unzip
Expand All @@ -10,8 +30,11 @@ into `/Library/QuickLook/` (to install system-globally),
or into `~/Library/QuickLook/` (to install for yourself only).
You may need to create this directory, if it does not exist.

To get sweet copy/paste functionality while in QuickLook, also run
To get sweet copy/paste functionality while in QuickLook, also run:

defaults write com.apple.finder QLEnableTextSelection -bool true

from a Terminal window.
from a Terminal window,
and to refresh installed plugins afterwards:

qlmanage -r

0 comments on commit 217dcb3

Please sign in to comment.