@sysvale/cuida 3.0.0-beta.7 → 3.0.0-beta.71

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,11 +1,12 @@
1
1
  <p align="center">
2
2
  <a href="https://sysvale.github.io/cuida">
3
- <img src="https://sysvale.github.io/cuida/static/media/CuidaTempLogo.f4adb1cc.png" alt="Cuida logo" width="350" />
3
+ <img src="https://framerusercontent.com/images/xz7CrU73qctPY2Vm79XMnTAVM.svg" alt="Cuida logo" width="250" />
4
4
  </a>
5
5
  </p>
6
6
 
7
7
  <div align="center">
8
8
  <p align="center">A design system built by Sysvale, using storybook and Vue components</p>
9
+ <p align="center">https://cuida.framer.wiki/</p>
9
10
  <p align="center">https://main--6168a1779cac8c003ab99c2d.chromatic.com</p>
10
11
  </div>
11
12
 
@@ -14,35 +15,20 @@
14
15
  - O Cuida pode ser instalado com o npm:
15
16
 
16
17
  ```bash
17
- $ npm i @sysvale/cuida;
18
+ npm i @sysvale/cuida;
18
19
  ```
19
20
 
20
21
  ## Usando
21
22
 
22
- - Instale o bootstrap-vue como dependência:
23
-
24
- ```bash
25
- $ npm i @sysvale/cuida;
26
- ```
27
-
28
- - Para usar o bootstrap-vue, importe a biblioteca no seu entry point, provavelmente vai ser seu main.js ou app.js:
29
-
30
- ```js
31
- import BootstrapVue from "bootstrap-vue";
32
- import "bootstrap/dist/css/bootstrap.css";
33
- import "bootstrap-vue/dist/bootstrap-vue.css";
34
- ```
35
-
36
- - Instale o bootstrap-vue com:
23
+ - Para usar o cuida, importe a biblioteca no seu entry point, provavelmente vai ser seu main.js ou app.js:
37
24
 
38
25
  ```js
39
- $ npm install bootstrap-vue bootstrap;
26
+ import Cuida from "@sysvale/cuida";
40
27
  ```
41
28
 
42
- - Para usar o cuida, importe a biblioteca no seu entry point, provavelmente vai ser seu main.js ou app.js:
43
-
29
+ - Importe os estilos do Cuida:
44
30
  ```js
45
- import Cuida from "@sysvale/cuida";
31
+ import '@sysvale/cuida/dist/style.css';
46
32
  ```
47
33
 
48
34
  - E instale o Cuida:
@@ -74,13 +60,13 @@ Vue.use(Cuida);
74
60
  - Clone o repositório:
75
61
 
76
62
  ```bash
77
- $ git clone https://github.com/Sysvale/cuida.git
63
+ git clone https://github.com/Sysvale/cuida.git
78
64
  ```
79
65
 
80
66
  - Instale as dependências e suba o container docker:
81
67
 
82
68
  ```bash
83
- $ docker-compose up -d
69
+ docker-compose up -d
84
70
  ```
85
71
 
86
72
  A aplicação estará disponível na porta `6006`, em [http://localhost:6006/](http://localhost:6006).
@@ -88,7 +74,7 @@ A aplicação estará disponível na porta `6006`, em [http://localhost:6006/](h
88
74
  - Caso não queira usar docker, instale as dependências com:
89
75
 
90
76
  ```bash
91
- $ npm i
77
+ npm i
92
78
  ```
93
79
 
94
80
  ### Executando o Cuida
@@ -98,7 +84,7 @@ $ npm i
98
84
  - Ou alternativamente, sem o docker, rode apenas:
99
85
 
100
86
  ```bash
101
- $ npm run storybook
87
+ npm run storybook
102
88
  ```
103
89
 
104
90
  ### Testando-o
@@ -106,21 +92,21 @@ $ npm run storybook
106
92
  - Utilizando o docker:
107
93
 
108
94
  ```bash
109
- $ docker-compose exec cuida npm run test
95
+ docker-compose exec cuida npm run test
110
96
  ```
111
97
 
112
98
  ou
113
99
 
114
100
  ```bash
115
- $ ./on-server.sh npm run test
101
+ ./on-server.sh npm run test
116
102
  ```
117
103
 
118
104
  - Sem o docker:
119
105
 
120
106
  ```bash
121
- $ npm run test
107
+ npm run test
122
108
  ```
123
109
 
124
110
  ## Contribuindo
125
111
 
126
- Para informações sobre como contribuir com o projeto, acesse o [CONTRIBUTING.MD](https://github.com/Sysvale/cuida/blob/master/CONTRIBUTING.md)
112
+ Para informações sobre como contribuir com o projeto, acesse o [CONTRIBUTING.MD](https://github.com/Sysvale/cuida/blob/main/CONTRIBUTING.md)