Skip to content

Commit 55e84c2

Browse files
committed
📝 Update README
1 parent 43a8c2d commit 55e84c2

File tree

2 files changed

+73
-1
lines changed

2 files changed

+73
-1
lines changed

README.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,73 @@
1-
vue-cli-plugin-proxy
1+
vue-cli-plugin-proxy
2+
<p align="center">
3+
<a
4+
href="https://assurance-maladie-digital.github.io/vue-cli-plugin-proxy/"
5+
target="_blank"
6+
rel="noopener noreferrer"
7+
>
8+
<img
9+
width="280"
10+
src="./docs/img/vuejs.png"
11+
alt="VueDot"
12+
>
13+
</a>
14+
</p>
15+
16+
<h1 align="center">CNAM – Vue CLI plugin proxy</h1>
17+
18+
<p align="center">This plugin is meant to provide all http-proxy-middleware options to vue-cli.</p>
19+
20+
<p align="center">
21+
<a href="https://www.npmjs.com/package/@cnamts/vue-cli-plugin-proxy">
22+
<img
23+
src="https://img.shields.io/npm/v/@cnamts/vue-cli-plugin-proxy.svg?style=flat-square"
24+
alt="NPM Version"
25+
>
26+
</a>
27+
<a href="https://www.npmjs.com/package/@cnamts/vue-cli-plugin-proxy">
28+
<img
29+
src="https://img.shields.io/npm/dw/@cnamts/vue-cli-plugin-proxy.svg?style=flat-square"
30+
alt="NPM Downloads"
31+
>
32+
</a>
33+
<a
34+
href="https://github.com/assurance-maladie-digital/vue-cli-plugin-proxy/blob/master/LICENSE">
35+
<img
36+
src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square"
37+
alt="License"
38+
>
39+
</a>
40+
</p>
41+
42+
## As Easy as 1, 2, 3
43+
44+
### Install
45+
46+
``` bash
47+
yarn add @cnamts/vue-cli-plugin-proxy # OR npm install @cnamts/vue-cli-plugin-proxy
48+
```
49+
50+
### Load
51+
52+
``` ts
53+
// main.ts
54+
import Vue from 'vue';
55+
import '@cnamts/vue-cli-plugin-proxy';
56+
57+
new Vue({
58+
render: (h) => h(App)
59+
}).$mount('#app');
60+
```
61+
62+
### You're done! 🎉
63+
64+
``` bash
65+
# run your project
66+
yarn serve # OR your own command
67+
```
68+
69+
It automatically load all components and directives of the library and made them available globally.
70+
71+
## License
72+
73+
Vue CLI plugin proxy is licensed under a [MIT License](./LICENSE).

docs/img/vuejs.png

9.6 KB
Loading

0 commit comments

Comments
 (0)