Skip to content

Commit

Permalink
Fix documentation typos (#3)
Browse files Browse the repository at this point in the history
* Update README.md

* Update package

Co-authored-by: John Chipps-Harding <john.chipps-harding@phntms.com>
  • Loading branch information
nattog and John Chipps-Harding committed Mar 1, 2021
1 parent 632d015 commit c59a798
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Actions Status][ci-image]][ci-url]
[![PR Welcome][npm-downloads-image]][npm-downloads-url]

A simple react hook that allows you to store data within `LocalStorage` with same interface as the standard `React.useState` hook.
A simple React hook that allows you to store data within `LocalStorage` with the same interface as the standard `React.useState` hook.

## Introduction

Expand Down Expand Up @@ -89,7 +89,7 @@ const SomeExample2 = () = {
### Output
An array containing the value and a function to set the value. Signiature is exactly like the standard [React.useState](https://reactjs.org/docs/hooks-state.html) hook.
An array containing the value and a function to set the value. Signature is exactly like the standard [React.useState](https://reactjs.org/docs/hooks-state.html) hook.
[npm-image]: https://img.shields.io/npm/v/@phntms/use-local-state.svg?style=flat-square&logo=react
[npm-url]: https://npmjs.org/package/@phntms/use-local-state
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@phntms/use-local-state",
"description": "A simple react hook that allows you to store data within LocalStorage with same interface as the standard React.useState hook.",
"version": "0.0.1",
"description": "A simple React hook that allows you to store data within LocalStorage with the same interface as the standard React.useState hook.",
"version": "0.0.2",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"homepage": "https://github.com/phantomstudios/use-local-state#readme",
Expand Down

0 comments on commit c59a798

Please sign in to comment.