Adiciona pacotes e script para gerar documentação 🎨

.gitignore

@@ -25,3 +25,4 @@ build/Release
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
+docs

.jsdoc.json

@@ -0,0 +1,12 @@
+{
+	"opts": {
+		"destination": "./docs/",
+		"encoding": "utf8",
+		"private": true,
+		"recurse": true,
+		"template": "node_modules/minami"
+	},
+    "source": {
+		"include": ["src", "package.json", "README.md"]
+	}
+}

README.md

@@ -1,6 +1,6 @@
 [![Stories in Ready](https://badge.waffle.io/lpirola/processador-inscricao-evento.png?label=ready&title=Ready)](https://waffle.io/lpirola/processador-inscricao-evento)
-# processador-inscricao-evento
-Processador de inscrições em eventos que utiliza uma planilha no Google Drive para controlar o envio de e-mail com boleto para pagamento e confirmação da inscrição
+# Processador de instricões em eventos
+É utilizado uma planilha no Google Drive para controlar o envio de e-mail com boleto para pagamento e confirmação da inscrição.
 
 ## Dependências
 
@@ -30,10 +30,20 @@ export GOOGLE_CREDS='{"type": "service_account","private_key_id": "","private_ke
 ./node_modules/.bin/babel-node src process
 ```
 
+## Docs
+
+Para ver a documentação, é necessário rodar os comandas abaixo. Na conclusão, será criado uma pasta chamada docs, que conterá arquivos html gerados para facilitar navegação
+
+```
+npm install --dev
+npm run generate-docs
+```
+
 ## Testes
 
 Para rodar os testes, as variáveis de ambiente não podem estar definidas. Algumas planilhas são utilizadas para realizar os testes. https://drive.google.com/folderview?id=0Bzc8qNdwn4IRcnNHYW1NMVZHUW8&usp=sharing
 
 ```
+npm install --dev
 npm test
 ```

package.json

@@ -4,7 +4,8 @@
   "description": "Processador de inscrições em eventos que utiliza uma planilha no Google Drive para controlar o envio de e-mail para pagamento e para confirmação da inscrição",
   "main": "index.js",
   "scripts": {
-    "test": "./node_modules/.bin/jasmine"
+    "test": "./node_modules/.bin/jasmine",
+    "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
   },
   "repository": {
     "type": "git",
@@ -25,11 +26,12 @@
     "async": "^1.5.0",
     "commander": "^2.9.0",
     "google-spreadsheet": "^1.0.1",
-    "jasmine-es6": "0.0.18",
     "nodemailer": "^1.10.0"
   },
   "devDependencies": {
     "babel-cli": "^6.2.1",
+    "minami": "^1.1.1",
+    "jasmine-es6": "0.0.18",
     "nodemailer-stub-transport": "^1.0.0"
   }
 }