Skip to content

Commit ccd64a7

Browse files
committed
Update README.md
1 parent e98c68e commit ccd64a7

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
11
JSON Editor Angular directive
22
=============================
33

4-
This is a directive that wraps jdorn's JSON Editor.
4+
ng-json-editor is an angular module that provides a directive that wraps [jdorn's JSON Editor](https://github.com/jdorn/json-editor).
55

66

7-
Project is based on Angular-Seed by Qmerce
7+
8+
Requirements
9+
----------------
10+
11+
The module doesn't include the original json-editor code, but it is included in it's bower dependencies.
12+
13+
Installation
14+
------------
15+
16+
Install ng-json-editor using bower, which will install the source json-editor as well.
17+
18+
If you are not using bower, please download the original [json-editor from here](https://github.com/jdorn/json-editor).
19+
20+
Usage
21+
-----
22+
23+
Include the json-editor and angular scripts first, and then include ng-json-editor.
24+
25+
Use the json-editor directive with a path to the schema you want to use.
26+
27+
```html
28+
<div json-editor="schema/schema_path.json"></div>
29+
```

0 commit comments

Comments
 (0)