Skip to content

Commit 3da4dc9

Browse files
committed
Update readme with Feathers V4 Notice
1 parent 2bac1b2 commit 3da4dc9

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@
1010
1111
`feathers-vuex` is a first class integration of the Feathers Client and Vuex. It implements many Redux best practices under the hood, eliminates *a lot* of boilerplate code, and still allows you to easily customize the Vuex store.
1212

13+
14+
___________________________________
15+
16+
> NOTICE: this module is almost (but not quite) fully compatible with Feathers V4. The authentication module is written for Feathers V3. If you're going to use Feathers V4, please search the [GitHub issues](https://github.com/feathers-plus/feathers-vuex/issues) for "feathers crow authentication" for workarounds you can implement until this module is properly updated.
17+
>
18+
> IN THE MEANTIME, it is highly recommended that you use the [pre-release version](https://github.com/feathers-plus/feathers-vuex/pull/216), which is production ready for Feathers V4. A proper migration guide and updated documentation are currently in progress.
19+
20+
___________________________________
21+
22+
23+
1324
## Features
1425

1526
- Fully powered by Vuex & Feathers

0 commit comments

Comments
 (0)