From 30aa73d3a3b6223b0d94562f7ea2afa05c2e0e5d Mon Sep 17 00:00:00 2001 From: jos Date: Fri, 14 Oct 2016 17:46:00 +0200 Subject: [PATCH] Dropped support for bower (don't commit bundles anymore) --- README.md | 31 ++++++++++++++++++---- bower.json | 32 ---------------------- dist/jsoneditor-minimalist.js | 33 ----------------------- dist/jsoneditor-minimalist.js.map | 1 - dist/jsoneditor.js | 33 ----------------------- dist/jsoneditor.js.map | 1 - dist/which files do I need.md | 24 ----------------- docs/api.md | 44 ++++++++++++++----------------- docs/usage.md | 44 +++++++++++-------------------- 9 files changed, 62 insertions(+), 181 deletions(-) delete mode 100644 bower.json delete mode 100644 dist/jsoneditor-minimalist.js delete mode 100644 dist/jsoneditor-minimalist.js.map delete mode 100644 dist/jsoneditor.js delete mode 100644 dist/jsoneditor.js.map delete mode 100644 dist/which files do I need.md diff --git a/README.md b/README.md index cbab023..5be6294 100644 --- a/README.md +++ b/README.md @@ -47,16 +47,37 @@ Supported browsers: Chrome, Firefox, Safari, Opera, Internet Explorer 9+. ## Install -with npm (recommended): +Install via npm: npm install jsoneditor -with bower: +### Versions - bower install jsoneditor +There are two versions of jsoneditor available: a full version and +a minimalist version. + +#### Full version + +If you're not sure which version to use, use the full version: jsoneditor.js. + +#### Minimalist version + +The minimalist version, jsoneditor-minimalist.js, has excluded the following libraries: + +- `ace` (via `brace`), used for the code editor. +- `ajv`, used for JSON schema validation. + +This reduces the the size of the minified and gzipped JavaScript considerably. + +When to use the minimalist version? + +- If you don't need the mode "code" and don't need JSON schema validation. +- Or if you want to provide `ace` and/or `ajv` yourself via the configuration + options, for example when you already use Ace in other parts of your + web application too and don't want to bundle the library twice. -#### More +### More There is a directive available for using `jsoneditor` in Angular.js: @@ -79,7 +100,7 @@ There is a directive available for using `jsoneditor` in Angular.js: +

- - + +