fixup typos/spelling in readme

half-halt · Jul 15, 2020 · 6cfc2d4 · 6cfc2d4
1 parent d7355cf
commit 6cfc2d4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # svg-jest
 
+![npm](https://img.shields.io/npm/v/svg-jest)
+![GitHub issues](https://img.shields.io/github/issues/half-halt/svg-jest)
 
 This is a small library which transforms .SVG files for jest. It produces
 and SVG in the stream.
@@ -39,15 +41,18 @@ The resulting HTML:
 
 ```html
 <div>
- <svg data-jest-file-name='an-image.svg' data-jest-svg-name='an-image' data-testid='an-image'/>
+ <svg 
+	data-jest-file-name='an-image.svg' 
+	data-jest-svg-name='an-image' 
+	data-testid='an-image'/>
 </div>
 ```
 
 In additoin, any properties passed to '<MySvg>' are passed along into both the snapshot
 and the resulting trees.
 
-# usage
-Configure jest:
+# Usage
+Configuring Jest, the example below uses package.json, but you can see: https://jestjs.io/docs/en/configuration for other examples.
 
 ```json
 {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "svg-jest",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A simple transformer for .SVG for Jest",
   "main": "index.js",
   "repository": "https://github.com/half-halt/svg-jest.git",