Skip to content

Commit e331cfe

Browse files
authored
[DOCS] updates readme and contribute files
[DOCS] updates readme and contribute files
2 parents 4ef21d2 + cd8639f commit e331cfe

File tree

8 files changed

+61
-226
lines changed

8 files changed

+61
-226
lines changed

Aptfile

Lines changed: 0 additions & 37 deletions
This file was deleted.

CONTRIBUTE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Guide for Contributors
2+
3+
> Note: If this is your first time contributing to a project, please read [this guide](https://github.com/Coding-in-community/.github/blob/master/FIRST_CONTRIBUTION.en.md) before proceeding.
4+
5+
## Index
6+
7+
- [Commit Convention](#commit-convention)
8+
- [Linter and Code formatter](#linter-and-code-formatter)
9+
10+
## Commit Convention
11+
12+
We are following [this](https://devbrotherhood.github.io/cmc/) convention for commits and everyone must follow it within the project.
13+
14+
## Linter and Code formatter
15+
16+
The linter used in the project is [ESLint](https://eslint.org/), while the code formatter is [Prettier](https://prettier.io/). Make sure you have the proper extensions installed in your editor.

CONTRIBUTE.pt.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Guia para Contribuidores
2+
3+
> Nota: Se essa é a sua primeira vez contribuindo em um projeto, leia [este guia](https://github.com/Coding-in-community/.github/blob/master/FIRST_CONTRIBUTION.pt.md) antes de prosseguir.
4+
5+
## Index
6+
7+
- [Commit Convention](#commit-convention)
8+
- [Linter e Code formatter](#linter-e-code-formatter)
9+
10+
## Commit Convention
11+
12+
Atualmente, estamos seguindo [esta](https://devbrotherhood.github.io/cmc/) convenção para commits e todos devem segui-la dentro do projeto.
13+
14+
## Linter e Code formatter
15+
16+
O linter usado no projeto é o [ESLint](https://eslint.org/), já o code formatter é o [Prettier](https://prettier.io/). Certifique-se de ter instalado as extensões apropriadas em seu editor.

CONTRIBUTE_pt.md

Lines changed: 0 additions & 173 deletions
This file was deleted.

Procfile

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
alice
55
</h1>
66
<blockquote>
7-
A multipurpose system based on Inside Heartz whatsapp bot
7+
A whatsapp bot made to manage coding groups.
88
</blockquote>
99
<div id="badges">
1010
<img src="https://img.shields.io/github/repo-size/Coding-in-community/alice?color=4000FF" alt="repo-size" />
@@ -18,11 +18,12 @@
1818
- [About the project](#-about-the-project)
1919
- [How to run](#-how-to-run)
2020
- [How to contribute](#-how-to-contribute)
21+
- [Credits](#-credits)
2122
- [License](#-license)
2223

2324
## 💻 About the project
2425

25-
A multipurpose system based on <a href="https://github.com/fdciabdul/InsideHeartz-WhatsApp-Bot">Inside Heartz</a> whatsapp bot
26+
Alice is a whatsapp bot made to manage coding groups.
2627

2728
### 🚀 How to run
2829

@@ -39,27 +40,33 @@ A multipurpose system based on <a href="https://github.com/fdciabdul/InsideHeart
3940
npm install
4041
```
4142

42-
3. Run the application
43+
3. set up `.env` file. See [.env.example](/.env.example)
44+
45+
4. Run the application
4346

4447
```bash
45-
node alice/index.js
48+
npm start
4649
```
4750

48-
4. Scan QR code using whatsapp
51+
5. Scan QR code with whatsapp
4952

5053
## 🤝 How to contribute
5154

5255
Every kind of contribution is welcome, we admire it!
5356

5457
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.
5558

56-
Want to contribute code? We ask that you first read [this contribution guide](https://github.com/firstcontributions/first-contributions)
59+
Want to contribute code? We ask that you first read [this contribution guide](/CONTRIBUTE.md)
5760

5861
Don't forget to leave your ⭐, it is also a way to contribute to the project;)
5962

63+
## 👾 Credits
64+
65+
API used in this Bot: [whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js)
66+
6067
## 📝 License
6168

62-
This project is under the MIT license. See the file [LICENSE](LICENSE) for more details.
69+
This project is under the MIT license. See [LICENSE](LICENSE) for more details.
6370

6471
---
6572

README-pt.md renamed to README.pt.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
alice
55
</h1>
66
<blockquote>
7-
A multipurpose system based on Inside Heartz whatsapp bot
7+
A whatsapp bot made to manage coding groups.
88
</blockquote>
99
<div id="badges">
1010
<img src="https://img.shields.io/github/repo-size/Coding-in-community/alice?color=4000FF" alt="repo-size" />
@@ -18,11 +18,12 @@
1818
- [Sobre o projeto](#-sobre-o-projeto)
1919
- [Como executar](#-como-executar)
2020
- [Como contribuir](#-como-contribuir)
21+
- [Créditos](#-créditos)
2122
- [Licença](#-licença)
2223

2324
## 💻 Sobre o projeto
2425

25-
A multipurpose system based on <a href="https://github.com/fdciabdul/InsideHeartz-WhatsApp-Bot">Inside Heartz</a> whatsapp bot
26+
Alice is a whatsapp bot made to manage coding groups.
2627

2728
### 🚀 Como executar
2829

@@ -39,27 +40,33 @@ A multipurpose system based on <a href="https://github.com/fdciabdul/InsideHeart
3940
npm install
4041
```
4142

42-
3. Rode a aplicação
43+
3. Configure o arquivo `.env`. Veja [.env.example](/.env.example)
44+
45+
4. Rode a aplicação
4346

4447
```bash
45-
node alice/index.js
48+
npm start
4649
```
4750

48-
4. Leia o código código QR usando o whatsapp
51+
5. Leia o código QR com o whatsapp
4952

5053
## 🤝 Como contribuir
5154

5255
Todo tipo de contribuição é bem-vinda, nós admiramos isso!
5356

5457
Tem algum problema? Encontrou um bug? Tem alguma dica? Abra uma [issue](https://github.com/Coding-in-community/alice/issues) descrevendo.
5558

56-
Quer contribuir com código? Pedimos que antes leia [este guia de contribuição](https://github.com/firstcontributions/first-contributions)
59+
Quer contribuir com código? Pedimos que antes leia [este guia de contribuição](/CONTRIBUTE.pt.md)
5760

5861
Não esqueça de deixar a sua ⭐, também é um modo de contribuir com o projeto ;)
5962

63+
## 👾 Créditos
64+
65+
API usada neste Bot: [whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js)
66+
6067
## 📝 Licença
6168

62-
Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
69+
Esse projeto está sob a licença MIT. Veja [LICENSE](LICENSE) para mais detalhes.
6370

6471
---
6572

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "alice",
33
"version": "0.0.8",
4-
"description": "A multipurpose system based on Inside Heartz whatsapp bot",
4+
"description": "A whatsapp bot made to manage coding groups.",
55
"main": "index.js",
66
"repository": {
77
"type": "git",

0 commit comments

Comments
 (0)