docs(readme): add example chord chart images to the readme

omnibrain · Sep 26, 2019 · 8402c22 · 8402c22
1 parent 8764864
commit 8402c22
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -12,6 +12,11 @@ JavaScript (TypeScript) library to create beautiful SVG guitar chord charts dire
 
 Demo: https://omnibrain.github.io/svguitar/  [ [source](https://github.com/omnibrain/svguitar/blob/master/demo/index.html) ]
 
+Example chord charts:
+
+![Example Chord Chart 1](https://raw.githubusercontent.com/omnibrain/svguitar/master/examples/example1.png)
+![Example Chord Chart 2](https://raw.githubusercontent.com/omnibrain/svguitar/master/examples/example2.png)
+
 ### Getting Started
 
 ```html
@@ -79,7 +84,9 @@ new SVGuitarChord('#some-selector')
         ],
       })
       .configure({
-        /**
+          // Customizations (all optional, defaults shown)
+
+          /**
            * The number of strings
            */
           strings: 6,

diff --git a/examples/example1.png b/examples/example1.png
diff --git a/examples/example2.png b/examples/example2.png