Skip to content

Commit 56cf66b

Browse files
committed
[DOCS] update readmes
1 parent 56f7696 commit 56cf66b

File tree

2 files changed

+122
-50
lines changed

2 files changed

+122
-50
lines changed

README-pt.md

Lines changed: 61 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,70 @@
1-
<h1 align="center">
2-
<br>
3-
<a href="https://github.com/Coding-in-community/alice">
4-
<img src="https://www.dropbox.com/s/9h3gdgq2ud2q114/circle-cropped.png?raw=1" width="150" height=150">
5-
</a>
6-
<br>
7-
Projeto Alice
8-
<br>
9-
</h1>
1+
<div align="center">
2+
<img src="https://www.dropbox.com/s/9h3gdgq2ud2q114/circle-cropped.png?raw=1" width="150" height="150">
3+
<h1>
4+
alice
5+
</h1>
6+
<blockquote>
7+
A multipurpose system based on Inside Heartz whatsapp bot
8+
</blockquote>
9+
<div id="badges">
10+
<img src="https://img.shields.io/github/repo-size/Coding-in-community/alice?color=4000FF" alt="repo-size" />
11+
<img src="https://img.shields.io/github/issues-raw/Coding-in-community/alice?color=4000FF" alt="issues" />
12+
<img src="https://img.shields.io/badge/license-MIT-4000FF" alt="license" />
13+
</div>
14+
</div>
1015

11-
<h3 align=center>Um sistema multiuso baseado no código do bot <a href="https://github.com/fdciabdul/InsideHeartz-WhatsApp-Bot"> Inside Heartz </a></h3>
16+
## Tabela de conteúdos
1217

13-
### Instalação
18+
- [Sobre o projeto](#-sobre-o-projeto)
19+
- [Como executar](#-como-executar)
20+
- [Como contribuir](#-como-contribuir)
21+
- [Licença](#-licença)
1422

15-
Clone o projeto
23+
## 💻 Sobre o projeto
1624

17-
```bash
18-
> git clone https://github.com/Coding-in-community/alice.git
19-
> cd alice
20-
```
25+
A multipurpose system based on <a href="https://github.com/fdciabdul/InsideHeartz-WhatsApp-Bot">Inside Heartz</a> whatsapp bot
2126

22-
Instale as dependências:
27+
### 🚀 Como executar
2328

24-
```bash
25-
> npm install
26-
```
29+
1. Clone o repositório
2730

28-
### Uso
31+
```bash
32+
git clone https://github.com/Coding-in-community/alice.git
33+
```
2934

30-
```bash
31-
> node index.js
32-
```
35+
2. Instale as dependências
3336

34-
Uma vez que o bot esteja rodando você pode escanear o qrcode
37+
```bash
38+
cd alice
39+
npm install
40+
```
41+
42+
3. Rode a aplicação
43+
44+
```bash
45+
node alice/index.js
46+
```
47+
48+
4. Leia o código código QR usando o whatsapp
49+
50+
## 🤝 Como contribuir
51+
52+
Todo tipo de contribuição é bem-vinda, nós admiramos isso!
53+
54+
Tem algum problema? Encontrou um bug? Tem alguma dica? Abra uma [issue](https://github.com/Coding-in-community/alice/issues) descrevendo.
55+
56+
Quer contribuir com código? Pedimos que antes leia [este guia de contribuição](https://github.com/firstcontributions/first-contributions)
57+
58+
Não esqueça de deixar a sua ⭐, também é um modo de contribuir com o projeto ;)
59+
60+
## 📝 Licença
61+
62+
Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
63+
64+
---
65+
66+
<div align="center">
67+
68+
Criado por [Coding in Community](https://github.com/Coding-in-community) 💜
69+
70+
</div>

README.md

Lines changed: 61 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,70 @@
1-
<h1 align="center">
2-
<br>
3-
<a href="https://github.com/Coding-in-community/alice">
4-
<img src="https://www.dropbox.com/s/9h3gdgq2ud2q114/circle-cropped.png?raw=1" width="150" height=150">
5-
</a>
6-
<br>
7-
Project Alice
8-
<br>
9-
</h1>
1+
<div align="center">
2+
<img src="https://www.dropbox.com/s/9h3gdgq2ud2q114/circle-cropped.png?raw=1" width="150" height="150">
3+
<h1>
4+
alice
5+
</h1>
6+
<blockquote>
7+
A multipurpose system based on Inside Heartz whatsapp bot
8+
</blockquote>
9+
<div id="badges">
10+
<img src="https://img.shields.io/github/repo-size/Coding-in-community/alice?color=4000FF" alt="repo-size" />
11+
<img src="https://img.shields.io/github/issues-raw/Coding-in-community/alice?color=4000FF" alt="issues" />
12+
<img src="https://img.shields.io/badge/license-MIT-4000FF" alt="license" />
13+
</div>
14+
</div>
1015

11-
<h3 align=center>A multipurpose system based on <a href="https://github.com/fdciabdul/InsideHeartz-WhatsApp-Bot"> Inside Heartz </a> whatsapp bot</h3>
16+
## Table of contents
1217

13-
### Install
18+
- [About the project](#-about-the-project)
19+
- [How to run](#-how-to-run)
20+
- [How to contribute](#-how-to-contribute)
21+
- [License](#-license)
1422

15-
Clone this project
23+
## 💻 About the project
1624

17-
```bash
18-
> git clone https://github.com/Coding-in-community/alice.git
19-
> cd alice
20-
```
25+
A multipurpose system based on <a href="https://github.com/fdciabdul/InsideHeartz-WhatsApp-Bot">Inside Heartz</a> whatsapp bot
2126

22-
Install dependencies:
27+
### 🚀 How to run
2328

24-
```bash
25-
> npm install
26-
```
29+
1. Clone the repository
2730

28-
### Usage
31+
```bash
32+
git clone https://github.com/Coding-in-community/alice.git
33+
```
2934

30-
```bash
31-
> node index.js
32-
```
35+
2. Install the dependencies
3336

34-
Once the bot is running you can scan the qr code with whatsapp
37+
```bash
38+
cd alice
39+
npm install
40+
```
41+
42+
3. Run the application
43+
44+
```bash
45+
node alice/index.js
46+
```
47+
48+
4. Scan QR code using whatsapp
49+
50+
## 🤝 How to contribute
51+
52+
Every kind of contribution is welcome, we admire it!
53+
54+
Is there any problem? Found a bug? Do you have any tips? Open an [issue](https://github.com/Coding-in-community/alice/issues) describing it.
55+
56+
Want to contribute code? We ask that you first read [this contribution guide](https://github.com/firstcontributions/first-contributions)
57+
58+
Don't forget to leave your ⭐, it is also a way to contribute to the project;)
59+
60+
## 📝 License
61+
62+
This project is under the MIT license. See the file [LICENSE](LICENSE) for more details.
63+
64+
---
65+
66+
<div align="center">
67+
68+
Created by [Coding in Community](https://github.com/Coding-in-community) 💜
69+
70+
</div>

0 commit comments

Comments
 (0)