Skip to content

Commit 1434f22

Browse files
committed
Update README
1 parent 1aaa8a5 commit 1434f22

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
11
# vlibras
22
Componente Vue.js que ajuda você a implementar o VLibras no seu site
3+
4+
Esse componente segue os padrões fornecidos na [documentação do vlibras](https://www.vlibras.gov.br/doc/widget/index.html).
5+
6+
> Os surdos enfrentam bastante dificuldade para ler, escrever e se comunicar na língua oral do seu país. Dessa forma, para tentar reduzir esses problemas, o objetivo da ferramenta computacional de código aberto, denominada VLibras Widget, consiste em traduzir conteúdos do Português Brasileiro para a Língua Brasileira de Sinais (LIBRAS), tornando websites acessíveis a pessoas surdas. -- [Visão geral vlibras](https://www.vlibras.gov.br/doc/widget/introduction/overview.html)
7+
8+
## Instalação
9+
10+
```shell
11+
npm install -S @vue-a11y/vlibras
12+
# or
13+
yarn add @vue-a11y/vlibras
14+
```
15+
16+
## Como usar
17+
No seu App.vue
18+
19+
```vue
20+
<template>
21+
<div id="app">
22+
<!-- header, navigation, and more -->
23+
<main id="main">
24+
<!-- content -->
25+
</main>
26+
<VLibras />
27+
</div>
28+
</template>
29+
30+
<script>
31+
import { VLibras } from '@vue-a11y/vlibras'
32+
33+
export default {
34+
name: 'App'
35+
components: {
36+
VLibras
37+
},
38+
//...
39+
}
40+
</script>
41+
```
42+
43+
## Contribuindo
44+
45+
- De erros de digitação na documentação à codificação de novos recursos;
46+
- Verifique os issue em aberto ou abra um novo issue para iniciar uma discussão sobre sua ideia de recurso ou o bug que você encontrou;
47+
- Dê um fork no repositório, fazendo as alterações e enviando um PR;
48+
49+
Nos siga no Twitter [@vue_a11y](https://twitter.com/vue_a11y)
50+
51+
**Obrigado por usar e fazer a web mais acessível**

0 commit comments

Comments
 (0)