@govbr-ds/webcomponents 1.4.1 → 1.5.0

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
@@ -27,12 +27,16 @@ Para conseguir usar nossa biblioteca sem problemas temos as seguintes dependênc
27
27
  ## Instalação
28
28
 
29
29
  ```bash
30
+
30
31
  npm install --save @govbr-ds/webcomponents
31
- ```## Uso
32
+ ```
33
+
34
+ ## Uso
32
35
 
33
- Depois de instalada, importe a biblioteca de dentro da parta node_modules:
36
+ Depois de instalada, importe a biblioteca de dentro da pasta *node_modules*:
34
37
 
35
38
  ```javascript
39
+
36
40
  @import "node_modules/@govbr-ds/webcomponents/dist/webcomponents.umd.min.js"
37
41
  ```
38
42
 
@@ -42,22 +46,25 @@ Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologi
42
46
 
43
47
  ## Rodando localmente
44
48
 
45
- Clone o projeto
49
+ Clone o projeto:
46
50
 
47
51
  ```bash
48
- git clone git@gitlab.com:govbr-ds/dev/wbc/govbr-ds-wbc.git
52
+
53
+ git clone git@gitlab.com:govbr-ds/dev/wbc/govbr-ds-wbc.git
49
54
  ```
50
55
 
51
- Entre no diretório do projeto
56
+ Entre no diretório do projeto:
52
57
 
53
58
  ```bash
54
- cd govbr-ds-wbc
59
+
60
+ cd govbr-ds-wbc
55
61
  ```
56
62
 
57
- Instale as dependências
63
+ Instale as dependências:
58
64
 
59
65
  ```bash
60
- npm install
66
+
67
+ npm install
61
68
  ```
62
69
 
63
70
  Para executar a nossa biblioteca a partir do código-fonte você tem 2 opções:
@@ -67,6 +74,7 @@ Para executar a nossa biblioteca a partir do código-fonte você tem 2 opções:
67
74
  Nessa visualização você executa o projeto em uma página auxiliar (fora do storybook) e sem compilar o resultado para Web Components.
68
75
 
69
76
  ```node
77
+
70
78
  npm run serve
71
79
  ```
72
80
 
@@ -77,6 +85,7 @@ Nessa visualização o projeto é executado a partir do storybook e convertido p
77
85
  Aqui você consegue testar as configurações, obter snippets de código e visualizar os componentes rodando como nos ambientes de produção.
78
86
 
79
87
  ```node
88
+
80
89
  npm run storybook
81
90
  ```
82
91