Skip to content

Commit aad35c0

Browse files
committed
docs: expand plugin description
1 parent e3746b7 commit aad35c0

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@
1919
</a>
2020
</p>
2121

22-
This plugin adds Soft Delete capabilities for the [Vuex ORM](https://github.com/vuex-orm/vuex-orm) library.
22+
Vuex ORM Soft Delete plugin adds soft delete capabilities to [Vuex ORM](https://github.com/vuex-orm/vuex-orm) models.
23+
24+
The plugin allows models to be soft deleted or "trashed" without actually removing them from the entity data set. Subsequently, when executing queries, the soft deleted models will be excluded from results. Using query modifiers, queries can be instructed to inclusively or exclusively retrieve soft deletes.
2325

2426
```js
2527
// Model action example...

docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Vuex ORM Soft Delete plugin adds soft delete capabilities on model entities.
44

5+
The plugin allows models to be soft deleted or "trashed" without actually removing them from the entity data set. Subsequently, when executing queries, the soft deleted models will be excluded from results. Using special query modifiers, queries can be instructed to inclusively or exclusively retrieve soft deletes.
6+
57
## Table of Contents
68

79
- Guide

src/VuexORMSoftDelete.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,17 @@ export default class VuexORMSoftDelete {
2828
actions: Store.Actions
2929

3030
/**
31-
* The store action tree.
31+
* The store getters tree.
3232
*/
3333
getters: Store.Getters
3434

3535
/**
36-
* The store action tree.
36+
* The store root getters tree.
3737
*/
3838
rootGetters: Store.RootGetters
3939

4040
/**
41-
* The store action tree.
41+
* The store root action tree.
4242
*/
4343
rootActions: Store.RootActions
4444

0 commit comments

Comments
 (0)