mu-forms - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
 	"name": "mu-forms",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Dead Simple HTML5 form management for React/Preact",
@@ -5,0 +5,0 @@ "main": "mu-forms.js",

README.md

@@ -5,3 +5,3 @@ # mu-forms
 
-![mu-forms logo](./mu-forms.svg)
+![mu-forms logo](https://cdn.rawgit.com/mobiushorizons/mu-forms/master/mu-forms.svg)
 
@@ -18,2 +18,22 @@ ## Rationale
 
+## Installing
+
+`mu-forms` can be installed from npm:
+
+    npm install mu-forms --save
+
+or using `Yarn`:
+
+    yarn add mu-forms
+
+## Importing
+
+To include it in a `Preact` project, import from `mu-forms/preact` like so:
+
+    import { Form, connectForm } from 'mu-forms/preact'
+
+Similarly to use it for `React` based projects, import from `mu-forms/react`
+
+    import { Form, connectForm } from 'mu-forms/react'
+
 ## Examples
@@ -200,3 +220,3 @@
 
-[src/common/form.js:34-159](https://github.com/MobiusHorizons/mu-forms/blob/d2fc6d9f910ffb0d4446dba83ffceca5b728ba53/src/common/form.js#L34-L159 "Source code on GitHub")
+[src/common/form.js:34-159](https://github.com/MobiusHorizons/mu-forms/blob/fc5d89e03370563ee57b1baf5b2f4d36bc4ba641/src/common/form.js#L34-L159 "Source code on GitHub")
 
@@ -219,3 +239,3 @@ **Extends Component**
 
-[src/common/form.js:93-108](https://github.com/MobiusHorizons/mu-forms/blob/d2fc6d9f910ffb0d4446dba83ffceca5b728ba53/src/common/form.js#L93-L108 "Source code on GitHub")
+[src/common/form.js:93-108](https://github.com/MobiusHorizons/mu-forms/blob/fc5d89e03370563ee57b1baf5b2f4d36bc4ba641/src/common/form.js#L93-L108 "Source code on GitHub")
 
@@ -258,3 +278,3 @@ The function passed to `onSubmit` will be called when the form is submitted, and all
 
-[src/common/form.js:93-108](https://github.com/MobiusHorizons/mu-forms/blob/d2fc6d9f910ffb0d4446dba83ffceca5b728ba53/src/common/form.js#L93-L108 "Source code on GitHub")
+[src/common/form.js:93-108](https://github.com/MobiusHorizons/mu-forms/blob/fc5d89e03370563ee57b1baf5b2f4d36bc4ba641/src/common/form.js#L93-L108 "Source code on GitHub")
 
@@ -271,3 +291,3 @@ The function passed to `onSubmitted` will be called once the submission is considered complete.
 
-[src/common/connect.js:87-122](https://github.com/MobiusHorizons/mu-forms/blob/d2fc6d9f910ffb0d4446dba83ffceca5b728ba53/src/common/connect.js#L87-L122 "Source code on GitHub")
+[src/common/connect.js:87-122](https://github.com/MobiusHorizons/mu-forms/blob/fc5d89e03370563ee57b1baf5b2f4d36bc4ba641/src/common/connect.js#L87-L122 "Source code on GitHub")
 
@@ -274,0 +294,0 @@ Wire up a component to the `<Form>`, giving it access to form data as `status`. If the connected component

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12481599

Number of lines in readme file

344

increased by6.17%

Number of medium supply chain risk alerts

6

decreased by-14.29%

No dependency changes