Skip to content

Commit fa3bc12

Browse files
committed
Update README
1 parent 02665b0 commit fa3bc12

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,46 @@
1-
# vlibras
1+
# vlibras (Para Vue3)
22
Componente Vue.js que ajuda você a implementar o VLibras no seu site.
33

4+
Demo: https://vue3-vlibras.surge.sh/
5+
46
Esse componente segue os padrões fornecidos na [documentação do vlibras](https://www.vlibras.gov.br/doc/widget/index.html).
57

68
> 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)
79
810
## Instalação
911

1012
```shell
11-
npm install -S @vue-a11y/vlibras
13+
npm install -S @vue-a11y/vlibras@next
1214
# or
13-
yarn add @vue-a11y/vlibras
15+
yarn add @vue-a11y/vlibras@next
1416
```
1517

18+
```js
19+
import { createApp } from 'vue'
20+
import App from './App.vue'
21+
import VLibras from '../../src'
22+
23+
createApp(App)
24+
.use(VLibras)
25+
.mount('#app')
26+
```
27+
1628
## Como usar
1729
No seu App.vue
1830

1931
```vue
2032
<template>
21-
<div id="app">
22-
<!-- header, navigation, and more -->
23-
<main id="main">
24-
<!-- content -->
25-
</main>
26-
<VLibras />
33+
<div>
34+
<a href="https://vitejs.dev" target="_blank">
35+
<img src="/vite.svg" class="logo" alt="Vite logo" />
36+
</a>
37+
<a href="https://vuejs.org/" target="_blank">
38+
<img src="./assets/vue.svg" class="logo vue" alt="Vue logo" />
39+
</a>
2740
</div>
41+
<HelloWorld msg="Vite + Vue" />
42+
<VLibras />
2843
</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>
4144
```
4245

4346
## Contribuindo

0 commit comments

Comments
 (0)