Skip to content

Commit da1d7e0

Browse files
cuebitcuebit
committed
chore: trim repo README
1 parent c0a8546 commit da1d7e0

File tree

1 file changed

+7
-139
lines changed

1 file changed

+7
-139
lines changed

‎README.md

Lines changed: 7 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -1,151 +1,19 @@
1-
<p align="center">
2-
<img width="192" src="https://github.com/vuex-orm/vuex-orm/raw/master/logo-vuex-orm.png" alt="Vuex ORM">
3-
</p>
1+
# vuex-orm-next [![Travis CI](https://travis-ci.org/vuex-orm/vuex-orm-next.svg?branch=master)](https://travis-ci.org/vuex-orm/vuex-orm-next) [![codecov](https://codecov.io/gh/vuex-orm/vuex-orm-next/branch/master/graph/badge.svg)](https://codecov.io/gh/vuex-orm/vuex-orm-next)
42

5-
<h1 align="center">Vuex ORM Next</h1>
3+
## Status: Draft
64

7-
<p align="center">
8-
<a href="https://www.npmjs.com/package/@vuex-orm/core">
9-
<img alt="npm" src="https://img.shields.io/npm/v/@vuex-orm/core?color=blue" alt="NPM">
10-
</a>
11-
<a href="https://travis-ci.org/vuex-orm/vuex-orm-next">
12-
<img src="https://travis-ci.org/vuex-orm/vuex-orm-next.svg?branch=master" alt="Travis CI">
13-
</a>
14-
<a href="https://codecov.io/gh/vuex-orm/vuex-orm-next">
15-
<img src="https://codecov.io/gh/vuex-orm/vuex-orm-next/branch/master/graph/badge.svg" alt="codecov">
16-
</a>
17-
<a href="https://github.com/vuex-orm/vuex-orm-next/blob/master/LICENSE">
18-
<img src="https://img.shields.io/npm/l/@vuex-orm/core.svg" alt="License">
19-
</a>
20-
</p>
5+
This repo is for the next iteration of Vuex ORM. It’s in an active development state and we are hoping it is going to be the foundation of the version 1.0.0 release. Any and all feedback is welcome!
216

22-
---
7+
The current implementation requires native ES2015+ in the runtime environment and does not support IE11 (yet).
238

24-
:fire: **This is the next iteration of Vuex ORM. It's in active development state, though we are hoping this is going to be the foundation of the version 1.0.0 release. Any feedbacks are welcome!**
25-
26-
---
27-
28-
Vuex ORM is a plugin for [Vuex](https://github.com/vuejs/vuex) to enable Object-Relational Mapping access to the Vuex Store. Vuex ORM lets you create "normalized" data schema within Vuex Store with relationships such as "Has One" and "Belongs To Many" like any other usual ORM library. It also provides fluent API to get, search and update Store state.
29-
30-
Vuex ORM is heavily inspired by Redux recipe of ["Normalizing State Shape"](https://redux.js.org/recipes/structuring-reducers/normalizing-state-shape) and ["Updating Normalized Data"](https://redux.js.org/recipes/structuring-reducers/updating-normalized-data). Learn more about the concept and motivation of Vuex ORM at [What is Vuex ORM?](https://vuex-orm.github.io/vuex-orm/guide/prologue/what-is-vuex-orm.html).
31-
32-
<h2 align="center">Sponsors</h2>
33-
34-
<p align="center">Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community :two_hearts:</p>
35-
36-
<h4 align="center">Super Love Sponsors</h4>
37-
38-
<p align="center">
39-
<a href="https://github.com/petertoth">
40-
<img src="https://avatars2.githubusercontent.com/u/3661783?s=460&v=4" alt="Peter Tóth" width="88">
41-
</a>
42-
<a href="https://github.com/phaust">
43-
<img src="https://avatars1.githubusercontent.com/u/2367770?s=460&v=4" alt="Mario Kolli" width="88">
44-
</a>
45-
<a href="https://github.com/cannikan">
46-
<img src="https://avatars2.githubusercontent.com/u/21893904?s=460&v=4" alt="Cannikan" width="88">
47-
</a>
48-
<a href="https://github.com/somazx">
49-
<img src="https://avatars0.githubusercontent.com/u/7306?s=460&v=4" alt="Andy Koch" width="88">
50-
</a>
51-
<a href="https://github.com/dylancopeland">
52-
<img src="https://avatars1.githubusercontent.com/u/99355?s=460&v=4" alt="Dylan Copeland" width="88">
53-
</a>
54-
</p>
55-
56-
<h4 align="center">Big Love Sponsors</h4>
57-
58-
<p align="center">
59-
<a href="https://github.com/geraldbiggs">
60-
<img src="https://avatars1.githubusercontent.com/u/3213608?s=460&v=4" alt="geraldbiggs" width="64">
61-
</a>
62-
<a href="https://github.com/cuebit">
63-
<img src="https://avatars0.githubusercontent.com/u/1493221?s=460&v=4" alt="Cue" width="64">
64-
</a>
65-
</p>
66-
67-
<h4 align="center">A Love Sponsors</h4>
68-
69-
<p align="center">
70-
<a href="https://github.com/georgechaduneli">
71-
<img src="https://avatars1.githubusercontent.com/u/9340753?s=460&v=4" alt="George Chaduneli" width="48">
72-
</a>
73-
<a href="https://github.com/bpuig">
74-
<img src="https://avatars3.githubusercontent.com/u/22938625?s=460&v=4" alt="bpuig" width="48">
75-
</a>
76-
<a href="https://github.com/robokozo">
77-
<img src="https://avatars2.githubusercontent.com/u/1719221?s=400&u=b5739798ee9a3d713f5ca3bd3d6a086c13d229a3&v=4" alt="John" width="48">
78-
</a>
79-
</p>
80-
81-
## Documentation
82-
83-
You can check out the full documentation for Vuex ORM Next at https://next.vuex-orm.org.
84-
85-
## Questions & Discussions
9+
In addition, new documentation is ongoing and can be found at https://next.vuex-orm.org.
8610

8711
Join us on our [Slack Channel](https://join.slack.com/t/vuex-orm/shared_invite/enQtNDQ0NjE3NTgyOTY2LTc1YTI2N2FjMGRlNGNmMzBkMGZlMmYxOTgzYzkzZDM2OTQ3OGExZDRkN2FmMGQ1MGJlOWM1NjU0MmRiN2VhYzQ) for any questions and discussions.
8812

89-
Although there is the Slack Channel, do not hesitate to open an [issue](https://github.com/vuex-orm/vuex-orm/issues) for any question you might have. We're always more than happy to hear any feedback, and we don't care what kind of form they are.
90-
91-
## Examples
92-
93-
Coming soon...
94-
95-
## Plugins
96-
97-
Coming soon...
98-
9913
## Contribution
10014

101-
We are excited that you are interested in contributing to Vuex ORM! Anything from raising an issue, submitting an idea of a new feature, or making a pull request is welcome!
102-
103-
### Scripts
104-
105-
There are several scripts to help with development.
106-
107-
```bash
108-
$ yarn build
109-
```
110-
111-
Compile files and generate bundles in `dist` directory.
112-
113-
```bash
114-
$ yarn lint
115-
```
116-
117-
Lint files using [Prettier](https://prettier.io/).
118-
119-
```bash
120-
$ yarn test
121-
```
122-
123-
Run the test using [Jest](https://jestjs.io/).
124-
125-
```bash
126-
$ yarn test:watch
127-
```
128-
129-
Run the test in watch mode.
130-
131-
```bash
132-
$ yarn test:perf
133-
```
134-
135-
Run the performance test.
136-
137-
```bash
138-
$ yarn coverage
139-
```
140-
141-
Generate test coverage in `coverage` directory.
142-
143-
```bash
144-
$ yarn docs
145-
```
146-
147-
Build and boot documentation server with [VuePress](https://vuepress.vuejs.org/).
15+
Community contributions will be applicable as soon as this repo reaches **alpha** stage.
14816

14917
## License
15018

151-
The Vuex ORM is open-sourced software licensed under the [MIT License](./LICENSE).
19+
Vuex ORM is open-sourced software licensed under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)