Skip to content

Commit

Permalink
Rename due to unavailability of package name (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kyzegs authored Aug 11, 2023
1 parent f2db698 commit b359560
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@

# react-hook-form-persistence
[![package version](https://img.shields.io/npm/v/react-hook-form-persistence.svg?style=flat-square)](https://npmjs.org/package/react-hook-form-persistence)
[![package downloads](https://img.shields.io/npm/dm/react-hook-form-persistence.svg?style=flat-square)](https://npmjs.org/package/react-hook-form-persistence)
# react-hook-form-persistant
[![package version](https://img.shields.io/npm/v/react-hook-form-persistant.svg?style=flat-square)](https://npmjs.org/package/react-hook-form-persistant)
[![package downloads](https://img.shields.io/npm/dm/react-hook-form-persistant.svg?style=flat-square)](https://npmjs.org/package/react-hook-form-persistant)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![package license](https://img.shields.io/npm/l/react-hook-form-persistence.svg?style=flat-square)](https://npmjs.org/package/react-hook-form-persistence)
[![package license](https://img.shields.io/npm/l/react-hook-form-persistant.svg?style=flat-square)](https://npmjs.org/package/react-hook-form-persistant)
[![make a pull request](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

Persist and populate [react-hook-form](https://react-hook-form.com/) form using storage of your choice

## 📖 Table of Contents

- [react-hook-form-persistence](#react-hook-form-persistence)
- [react-hook-form-persistant](#react-hook-form-persistant)
- [📖 Table of Contents](#-table-of-contents)
- [⚙️ Install](#️-install)
- [📖 Usage](#-usage)
Expand All @@ -25,17 +25,17 @@ Install the package locally within you project folder with your package manager:

With `npm`:
```sh
npm install react-hook-form-persistence
npm install react-hook-form-persistant
```

With `yarn`:
```sh
yarn add react-hook-form-persistence
yarn add react-hook-form-persistant
```

With `pnpm`:
```sh
pnpm add react-hook-form-persistence
pnpm add react-hook-form-persistant
```

## 📖 Usage
Expand All @@ -45,7 +45,7 @@ import React from "react";
import ReactDOM from "react-dom";
import { useForm } from "react-hook-form";

import useFormPersist from 'react-hook-form-persistence'
import useFormPersist from 'react-hook-form-persistant'

function App() {
const { register, handleSubmit, watch, errors, setValue } = useForm();
Expand Down Expand Up @@ -112,7 +112,7 @@ useFormPersist('form', {watch, setValue, include: ['email'] });

## 📚 API

For all configuration options, please see the [API docs](https://paka.dev/npm/react-hook-form-persistence).
For all configuration options, please see the [API docs](https://paka.dev/npm/react-hook-form-persistant).

## 💬 Contributing

Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "react-hook-form-persistence",
"name": "react-hook-form-persistant",
"version": "1.0.0",
"description": "Persist and populate react-hook-form form using storage of your choice",
"types": "dist/index.d.ts",
Expand All @@ -19,7 +19,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/kyzegs/react-hook-form-persistence.git"
"url": "git+https://github.com/kyzegs/react-hook-form-persistant.git"
},
"keywords": [
"react-hook-form",
Expand All @@ -39,9 +39,9 @@
],
"license": "MIT",
"bugs": {
"url": "https://github.com/kyzegs/react-hook-form-persistence/issues"
"url": "https://github.com/kyzegs/react-hook-form-persistant/issues"
},
"homepage": "https://github.com/kyzegs/react-hook-form-persistence#readme",
"homepage": "https://github.com/kyzegs/react-hook-form-persistant#readme",
"devDependencies": {
"@testing-library/dom": "^9.3.1",
"@testing-library/jest-dom": "^5.17.0",
Expand Down
2 changes: 1 addition & 1 deletion tests/index.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const Form = ({ config = {}, props = {} }: { config?: Partial<FormPersistConfig>
);
};

describe('react-hook-form-persistence', () => {
describe('react-hook-form-persistant', () => {
test('should persist fields in storage', async () => {
const spy = vi.spyOn(Storage.prototype, 'setItem');

Expand Down

0 comments on commit b359560

Please sign in to comment.