diff --git a/README.md b/README.md index d8b1024..0c0a808 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ * simple cache for vuex action -## How to install +### How to install ```bash npm install vuex-simple-cache # OR yarn add vuex-simple-cache ``` -## How to use +### How to use ```js import Vue from 'vue'; import Vuex, { Store } from 'vuex'; @@ -45,6 +45,11 @@ store.registerModule('test', { }) ``` +### API - cacheAction +* key - name of key from vuex state +* action - standard vuex action +* expiration - time in seconds + [npm]: https://img.shields.io/npm/v/@vencakrecl/vuex-simple-cache.svg?style=flat-square [license]: https://img.shields.io/npm/l/@vencakrecl/vuex-simple-cache.svg?style=flat-square [ci]: https://img.shields.io/github/workflow/status/VencaKrecl/vuex-simple-cache/CI \ No newline at end of file diff --git a/package.json b/package.json index 064ec97..7362db7 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@vencakrecl/vuex-simple-cache", "author": "Venca Krecl ", "description": "Simple cache for vuex action", - "version": "1.0.0-alpha.6", + "version": "1.0.0-alpha.7", "license": "MIT", "repository": { "type": "git",