Improved README.md (Install)

abodelot · Aug 19, 2019 · 232969b · 232969b
1 parent 4ae7456
commit 232969b
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -14,17 +14,27 @@ Features:
 
 Check out the [demo page](http://rawgit.com/abodelot/jquery.json-viewer/master/demo.html)!
 
-## Usage
-
-Import `jquery.json-viewer.js` and `jquery.json-viewer.css` in your application.
+## Install
 
 Copy sources from git repository, or use npm:
 
 ```sh
 npm install jquery.json-viewer
 ```
 
-Then just call the `jsonViewer()` method and pass your JSON data in argument:
+Make sure jQuery is already included. Then import `jquery.json-viewer.js` and `jquery.json-viewer.css` in your HTML document:
+
+```html
+<head>
+  <script src="json-viewer/jquery.json-viewer.js"></script>
+  <link href="json-viewer/jquery.json-viewer.css" type="text/css" rel="stylesheet">
+</head>
+```
+
+## Usage
+
+Call the `jsonViewer()` method on target element and pass your JSON data in argument:
+
 ```html
 <pre id="json-renderer"></pre>
 ```

diff --git a/demo.html b/demo.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
     <script src="json-viewer/jquery.json-viewer.js"></script>
-    <link href="json-viewer/jquery.json-viewer.css" type="text/css" rel="stylesheet" />
+    <link href="json-viewer/jquery.json-viewer.css" type="text/css" rel="stylesheet">
 
     <style type="text/css">
 body {