Skip to content

Commit eea1b4f

Browse files
committed
readme [skip ci]
1 parent f18ae1d commit eea1b4f

File tree

1 file changed

+41
-24
lines changed

1 file changed

+41
-24
lines changed

readme.md

Lines changed: 41 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,44 @@
22

33
<p align="center"><a href="https://pikax.me/vue-composable/" target="_blank" rel="noopener noreferrer"><img width="250" src="https://pikax.me/vue-composable/assets/logo.svg" alt="vue-composable logo"></a></p>
44

5-
<!-- [![CircleCI](https://circleci.com/gh/pikax/vue-composable.svg?style=svg)](https://circleci.com/gh/pikax/vue-composable) -->
6-
7-
[![Coverage Status](https://coveralls.io/repos/github/pikax/vue-composable/badge.svg?branch=vue3)](https://coveralls.io/github/pikax/vue-composable?branch=vue3)
8-
9-
<!-- [![npm version](https://badge.fury.io/js/vue-composable.svg)](https://badge.fury.io/js/vue-composable) -->
10-
11-
[![bundle size](https://badgen.net/bundlephobia/minzip/vue-composable@next)](https://bundlephobia.com/result?p=vue-composable@next)
12-
13-
# Vue 3
14-
15-
This version is `alpha` with support for the vue3 ([vue-next](https://github.com/vuejs/vue-next))
16-
17-
> Check webpack [vue3 example](https://github.com/pikax/vue-composable/tree/vue3/examples/vue-next-webpack-preview-master) or [CodeSandbox](https://codesandbox.io/s/vue-composable-next-6m5et)
5+
[![CircleCI](https://circleci.com/gh/pikax/vue-composable.svg?style=svg)](https://circleci.com/gh/pikax/vue-composable)
6+
[![Coverage Status](https://coveralls.io/repos/github/pikax/vue-composable/badge.svg?branch=master)](https://coveralls.io/github/pikax/vue-composable?branch=master)
7+
[![npm version](https://badge.fury.io/js/vue-composable.svg)](https://badge.fury.io/js/vue-composable)
8+
[![bundle size](https://badgen.net/bundlephobia/minzip/vue-composable)](https://bundlephobia.com/result?p=vue-composable@next)
189

1910
## Introduction
2011

21-
`vue-composable` is out-of-box ready to use the brand new [Vue 3](https://github.com/vuejs/vue-next) [composition-api](https://vue-composition-api-rfc.netlify.com/) generic components.
12+
`vue-composable` is out-of-box ready to use [composition-api](https://github.com/vuejs/composition-api) generic components.
2213

2314
100% typescript based composable components and full type support out-of-box.
2415

25-
This library aim is to be one stop shop for many real-world composable functions, with aggressive tree-shaking to keep it light on your end code.
26-
27-
[vue-composable](https://www.npmjs.com/package/vue-composable) is composed by two package [@vue-composable/core](./packages/core) and [@vue-composable/web](./packages/web).
16+
Built for [vue-next](https://github.com/vuejs/vue-next) and [composition-api](https://github.com/vuejs/composition-api)
2817

29-
- [@vue-composable/core](./packages/core): contains helpers composables, such as Promise and Pagination.
30-
- [@vue-composable/web](./packages/web): contains [Web API](https://developer.mozilla.org/en-US/docs/Web/API) implementations
18+
This library aim is to be one stop shop for many real-world composable functions, with aggressive tree-shaking to keep it light on your end code.
3119

3220
# Vue 3
3321

34-
> ## Support for `vue@next` on [vue3 branch](https://github.com/pikax/vue-composable/tree/vue3)
22+
[Vue3](https://github.com/vuejs/vue-next) aka [vue-next](https://github.com/vuejs/vue-next) is supported on the [@next](https://www.npmjs.com/package/vue-composable/v/next)
3523

3624
## Installing
3725

3826
```bash
27+
# @vue/composition-api
28+
29+
# install with yarn
30+
yarn add @vue/composition-api vue-composable
31+
32+
# install with npm
33+
npm install @vue/composition-api vue-composable
34+
35+
36+
# vue-next / [email protected]
37+
3938
# install with yarn
40-
yarn add vue@next vue-composable@next
39+
yarn add vue-composable@next
4140

4241
# install with npm
43-
npm install vue@next vue-composable@next
42+
npm install vue-composable@next
4443
```
4544

4645
## Documentation
@@ -130,10 +129,11 @@ Check our [documentation](https://pikax.me/vue-composable/)
130129
> New packages needed
131130
132131
- [Axios](https://pikax.me/vue-composable/composable/external/axios) - [@vue-composable/axios](https://www.npmjs.com/package/@vue-composable/axios) reactive `axios` wrapper client
132+
- [makeAxios](https://pikax.me/vue-composable/composable/external/makeAxios) - [@vue-composable/makeAxios](https://www.npmjs.com/package/@vue-composable/makeAxios) wrap your `axios` instance
133133

134134
## Information
135135

136-
This is a monorepo project, please check [packages](packages/) or check [vue-composable](packages/vue-composable)
136+
This is a monorepo project, please check [packages](packages/)
137137

138138
## Contributing
139139

@@ -143,7 +143,24 @@ Tests and Documentation are the most important things for me, because good docum
143143

144144
I really appreciate some tweaks or changes on how the documentation is displayed and how to make it easier to read.
145145

146-
> I really need an logo for this project, if you have a good idea for a logo, please enter in contact with me, you can find me on the `Vue discord : @pikax`
146+
> I really need an logo for this project, if you have a good idea for a logo, please enter in contact with me, you can find me on the `Vue discord : @pikax
147+
148+
Twitter: [@pikax_dev](https://twitter.com/pikax_dev)
149+
150+
## Build
151+
152+
```bash
153+
# install packages
154+
yarn
155+
156+
# build and test for v2
157+
yarn build --version=2
158+
yarn test:vue2
159+
160+
# build and test for v3
161+
yarn build
162+
yarn test
163+
```
147164

148165
### New composable
149166

0 commit comments

Comments
 (0)