From 6f62226259b339ef57e9ad21f4f072890f3e5f80 Mon Sep 17 00:00:00 2001
From: Lukas Pol <lukaspaespol@gmail.com>
Date: Sat, 11 Mar 2023 16:46:40 -0300
Subject: [PATCH] doc: update README

---
 README.md | 45 ++++++++++++++++++++++++++++++++-------------
 1 file changed, 32 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 7db80e4..09e5154 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,43 @@
-# README
+# Minhas Financias
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+Um Projeto para acompanhar seus ativos e proventos.
 
-Things you may want to cover:
+## Funcionalidades
 
-* Ruby version
+- Cadastrar movimentações(compra, venda, grupamento) das ações;
+- Ver preços médios e total investido atualizados;
+- Importar o extrato do site B3;
 
-* System dependencies
+### Funcionalidades para serem desenvolvidas
 
-* Configuration
+- Cadastrar proventos(JCP e dividendos);
+- Preço da ação no mercado;
+- Próximos dividendos que irá receber;
+- Exportar preencher o IRPF;
 
-* Database creation
+Deseja uma nova funcionalidade, que não estaje listada?
 
-* Database initialization
+Abra uma [issue](https://github.com/LukasPol/my-finances/issues/new)
 
-* How to run the test suite
 
-* Services (job queues, cache servers, search engines, etc.)
+## Parte Técnica
 
-* Deployment instructions
+### Dependências
 
-* ...
+- Ruby v3.1.2
+- Rails v7.0.3
+- Postgresql v^12
+
+### Dando Start
+
+1. `git clone git@github.com:LukasPol/my-finances.git`
+2. `cd my-finances`
+3. `cp .env.sample .env` (copiando as variáveis de ambiente)
+4. Troque as  variáveis no arquivo .env
+5. `rake db:setup`
+6. `./bin/dev`
+
+
+### Rodando os testes
+
+`rspec spec`
\ No newline at end of file