chore: add changelog (#7)

jollyjerr · Oct 16, 2021 · d65a0ac · d65a0ac
1 parent dc31beb
commit d65a0ac
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.0] - 10-16-21
+
+### Added
+
+- Linting and format checking.
+
+### Changed
+
+- Hook and component both fire on unmount with current, not debounced, value.
+
+## [0.2.2] - 5-18-21
+
+### Added
+
+- Test coverage report.
+
+### Removed
+
+- lodash dependency.
+
+## [0.2.0] - 5-16-21
+
+### Added
+
+- `useAutosave` hook.
+
+## [0.1.5] - 10-10-20
+
+### Added
+
+- `<Autosave>` component.
+- Readme.
diff --git a/README.md b/README.md
@@ -75,13 +75,21 @@ const EditBlogFormWithHook = () => {
 };
 ```
 
+## Installation
+
+```sh
+yarn add react-autosave
+# or with npm...
+npm i react-autosave
+```
+
 ## Features
 
 1. Written in typescript.
 
 2. Lightweight and simple.
 
-3. No external libraries.
+3. No dependencies.
 
 ## API
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-autosave",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "A super simple debouncing component/hook to auto save controlled form values as they are updated",
   "repository": "https://github.com/jollyjerr/react-autosave",
   "author": "jollyjerr <[email protected]>",