@guinie/react-testid - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "@guinie/react-testid",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A library of utilities for producing test IDs for React components.",
@@ -40,3 +40,3 @@ "main": "src/index.js",
   },
-  "gitHead": "3ef02de88d77f314a293161057eef88829a52423"
+  "gitHead": "7614fc929ee37680cf30df0cdfd159c2b6fff4f9"
 }

README.md

 # @guinie/react-testid
 
-<blockquote>
-  <p>
-
-  </p>
-</blockquote>
-
 A library of utilities for producing test IDs for React components.
@@ -31,10 +25,14 @@
 
-`testId => Object`
+`(testId[, options]) => Object`
 
 A utility function for producing test ID props.
 
+@param options – Object: {
+  testIdProps: string[]
+}
+
 Example:
 
 ```
-const { makeTestIdProps } = require('@guinie/react')
+const { makeTestIdProps } = require('@guinie/react-testid')
 
@@ -54,6 +52,10 @@ const MyButton = props => { ... }
 
-`testId => ReactComponentInstance => ReactComponentInstance`
+`(testId[, options]) => ReactComponentInstance => ReactComponentInstance`
 
 A utility function for applying test IDs to React component instances.
 
+@param options – Object: {
+  testIdProps: string[]
+}
+
 Example:
@@ -60,0 +62,0 @@

No alert changes

Improved metrics

Total package byte prevSize

3707

increased by2.86%

Number of lines in readme file

89

increased by2.3%

No dependency changes