Merge pull request #9 from BearingMe/master

update on docs

Author: BearingMe

.gitignore

@@ -1,2 +1,2 @@
-node_modules/
-/session.json
+alice/node_modules/
+alice/system/auth/session.json

CONTRIBUTE.md

@@ -1,11 +1,11 @@
-# Guia Para Contribuidores do Alice Bot
+# Guia Para Contribuidores do Projeto
 
 ## Index
 
 - [Como contribuir?](#como-contribuir)
    - [1º Passo](#1º-passo) - Fork
    - [2º Passo](#2º-passo) - Clonagem
-   - [3º Passo](#3º-passo) - Add linke para repositório oficial
+   - [3º Passo](#3º-passo) - Add link para repositório oficial
    - [4º Passo](#4º-passo) - Crie uma branch para contribuir
    - [5º Passo](#5º-passo) - Adicione e commite a contribuição
    - [6º Passo](#6º-passo) - Envie a branch com a contribuição para o fork
@@ -37,15 +37,15 @@ Você será redirecionado para sua conta assim que o processo for concluído.
 Após ter o repositório em sua conta, faça o **clone** em seu ambiente local:
 
 ```bash
-$ git clone https://github.com/<NOME_DA_SUA_CONTA>/WhatsAppBot_ProjectAlice.git
+$ git clone https://github.com/<NOME_DA_SUA_CONTA>/whatsappbot-project_alice.git
 ```
 
 ### 3º Passo
 
-Com o clone em seu ambiente, linke o repositório local ao remoto da organização [Coding in Community](https://github.com/Coding-in-community/WhatsAppBot_ProjectAlice):
+Com o clone em seu ambiente, linke o repositório local ao remoto da organização [Coding in Community](https://github.com/Coding-in-community/whatsappbot-project_alice):
 
 ```bash
-$ git remote add upstream https://github.com/Coding-in-community/WhatsAppBot_ProjectAlice.git
+$ git remote add upstream https://github.com/Coding-in-community/whatsappbot-project_alice.git
 ```
 
 Isso servirá para sincronizar atualizações feitas no repositório oficial para seu ambiente local.
@@ -61,10 +61,10 @@ $ git remote --v
 Se tudo ocorreu bem, deverá ter uma saída semelhante a essa:
 
 ```bash
-origin  https://github.com/<NOME_DA_SUA_CONTA>/WhatsAppBot_ProjectAlice.git (fetch)
-origin  https://github.com/<NOME_DA_SUA_CONTA>/WhatsAppBot_ProjectAlice.git (push)
-upstream        https://github.com/Coding-in-community/WhatsAppBot_ProjectAlice.git (fetch)
-upstream        https://github.com/Coding-in-community/WhatsAppBot_ProjectAlice.git (push)
+origin  https://github.com/<NOME_DA_SUA_CONTA>/whatsappbot-project_alice.git (fetch)
+origin  https://github.com/<NOME_DA_SUA_CONTA>/whatsappbot-project_alice.git (push)
+upstream        https://github.com/Coding-in-community/whatsappbot-project_alice.git (fetch)
+upstream        https://github.com/Coding-in-community/whatsappbot-project_alice.git (push)
 ```
 
 ### 4º Passo

CONTRIBUTING.md renamed to CONTRIBUTE_pt.md

@@ -0,0 +1,34 @@
+<h1 align="center">
+  <br>
+      <a href="https://github.com/Coding-in-community/whatsappbot-project_alice">
+        <img src="https://www.dropbox.com/s/9h3gdgq2ud2q114/circle-cropped.png?raw=1" width="150" height=150">
+      </a>
+  <br>
+    Projeto Alice
+  <br>
+</h1>
+
+<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>
+
+### Instalação
+
+Clone o projeto
+
+```bash
+> git clone https://github.com/Coding-in-community/whatsappbot-project_alice.git
+> cd whatsappbot-project_alice
+```
+
+Instale as dependências:
+
+```bash
+> npm install
+```
+
+### Uso
+
+```bash
+> node index.js
+```
+
+Uma vez que o bot esteja rodando você pode escanear o qrcode

README-pt.md

@@ -8,7 +8,7 @@
   <br>
 </h1>
 
-<h3 align=center>A multipurpose whatsapp bot based on <a href="https://github.com/fdciabdul/InsideHeartz-WhatsApp-Bot"> Inside Heartz </a> project</h3>
+<h3 align=center>A multipurpose system based on <a href="https://github.com/fdciabdul/InsideHeartz-WhatsApp-Bot"> Inside Heartz </a> whatsapp bot</h3>
 
 ### Install
 

README.md

@@ -2,12 +2,12 @@ const Alice = require('./system')
 const { component } = require('./system/utils')
 
 let alice = new Alice([
-    component('add', require('./scripts/add')),
-    component('demote', require('./scripts/demote')),
     component('github', require('./scripts/github')),
-    component('remove', require('./scripts/remove')),
-    component('link', require('./scripts/link')),
     component('_example', require('./scripts/_example')),
+    // component('add', require('./scripts/add')),
+    // component('demote', require('./scripts/demote')),
+    // component('remove', require('./scripts/remove')),
+    // component('link', require('./scripts/link')),
 ])
 
 alice.init()