From e339af38744b4be384fa68f696ae5232b59d4ad9 Mon Sep 17 00:00:00 2001 From: ztimson Date: Mon, 1 Feb 2021 23:56:05 -0500 Subject: [PATCH] Updated docs --- README.md | 17 +++++++++++++++++ package.json | 3 ++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb120d3..a04d287 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,23 @@ export class MyCustomClass { } ``` +## Documentation + +### Decorators + +| Decorator | Description | +|-----------|-------------| +| @LocalStorage(defaultValue: any, options: WebStorageOptions) | Syncs property to LocalStorage item under the same name | +| @SessionStorage(defaultValue: any, options: WebStorageOptions) | Syncs property to SessionStorage item under the same name | + +### WebStorageOptions + +| Options | Description | +|---------|-------------| +| default | Default value, same as decorator's first argument | +| encryptWith | Secret key to encrypt stored values with | +| key | Key to reference value inside local/session storage (Defaults to the property name) | + ## Caveats ### Custom Functions diff --git a/package.json b/package.json index 7db4a82..50046aa 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { "name": "webstorage-decorators", - "version": "3.1.5", + "version": "3.2.5", "description": "Decorators to sync class properties to Local/Session storage", + "repository": "https://github.com/ztimson/WebstorageDecorators", "main": "./lib/index.js", "typings": "./lib/index.d.ts", "scripts": {