Merge pull request #202 from joshnuss/rename

feat: Complete rename

README.md

@@ -2,4 +2,55 @@
 
 # svelte-persisted-store
 
-**Package has been renamed to [svelte-presisted-store](https://www.npmjs.com/package/svelte-persisted-store)**
+A Svelte store that persists to local storage. Supports changes across multiple tabs.
+
+## Installation
+
+```bash
+npm install svelte-persisted-store
+```
+
+## Usage
+
+Define the store:
+
+```javascript
+import { persisted } from 'svelte-persisted-store'
+
+// First param `preferences` is the local storage key.
+// Second param is the initial value.
+export const preferences = persisted('preferences', {
+  theme: 'dark',
+  pane: '50%',
+  ...
+})
+```
+
+Then when you want to use the store:
+
+```javascript
+import { get } from 'svelte/store'
+import { preferences } from './stores'
+
+preferences.subscribe(...) // subscribe to changes
+preferences.update(...) // update value
+preferences.set(...) // set value
+get(preferences) // read value
+$preferences // read value with automatic subscription
+```
+
+You can also optionally set the `serializer` or `storage` type:
+
+```javascript
+import * as devalue from 'devalue'
+
+// third parameter is options.
+export const preferences = persisted('local-storage-key', 'default-value', {
+  serializer: devalue, // defaults to `JSON`
+  storage: 'session' // 'session' for sessionStorage, defaults to 'local'
+})
+```
+
+## License
+
+MIT

package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-persisted-store",
-  "version": "0.6.4",
+  "version": "0.0.0-development",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",