From 217dcb3cf3e14c7ac1975b19095f40f2e59cc27e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johan=20Sundstr=C3=B6m?= Date: Tue, 29 Sep 2015 17:52:16 -0700 Subject: [PATCH] Improve the README a bit --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c5613c8..327165c 100644 --- a/README.md +++ b/README.md @@ -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 " + , "Bill Fisher " + , "Paul O'Shannessy " + ] +} +``` + +### Installing To install a pre-built version for osx 10.6+, download and unzip @@ -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