atualiza readme

README.md

@@ -1,28 +1,28 @@
-# README
+# Turing Quant
 
-Esse repositório tem a intenção de ajudar os membros do Grupo Turing Quant a obter dados sobre cotações de ações e dados de mercado, como balanços de empresas e algumas outras informações sobre o mercado financeiro.
+`turingquant` é uma biblioteca para coleta, análise e backtesting de ativos e estratégias financeiras. O projeto está em desenvolvimento ativo pelos membros de Finanças Quantitativas do [Grupo Turing](https://github.com/grupoturing).
 
-## Uso
+`pip install turingquant` instala a última versão estável.
 
-Para seu pleno uso, são necessárias algumas outras bibliotecas e credenciais. Para isso use o pip para instalar alguns pacotes em seu environment:
+## Utilização
 
-`pip install pandas alpha-vantage beautifulsoup4`
+A biblioteca conta com 3 módulos: `metrics`, `benchmark`, e `support`.
 
-A API de onde obtemos os dados de mercado é a Alpha Vantage e você pode obter a [chave de uso gratuitamente](https://www.alphavantage.co/support/#api-key). Essa chave será necessária sempre que você utilizar as funções `daily` e `intraday`.
+`support` possui funções para obter dados fundamentalistas de empresas.
 
-## Funções
-Por enquanto o helper tem as seguintes funções:
+`metrics` possui funções para obter informações e indicadores sobre uma série de retornos.
 
-- `daily` - fornece cotação diária de todos os ativos negociados em bolsa
-- `intraday` - fornece cotação minuto a minuto dos últimos 5 dias de negociação
-- `get_fundamentus` - obtém dados do site fundamentus.com.br sobre uma ação ou lista de ações
-- `get_tickers` - obtém todos os tickers negociados na B3 à partir do fundamentus
-- `get_ibov` - obtém a última carteira do Índice Ibovespa
+`benchmark` possui funções para calcular o retorno de um ativo em um dado intervalo de tempo.
+
+A API de onde obtemos os dados fundamentalistas é a Alpha Vantage e você pode obter a [chave de uso gratuitamente](https://www.alphavantage.co/support/#api-key). Essa chave será necessária sempre que você utilizar as funções `daily` e `intraday`.
 
 No código você pode verificar o que cada função retorna e a descrição de cada parâmetro que as funções recebem.
 
-## Feito por:
+## Contribuidores
+
+- [Gabriel Mossato](https://github.com/gvmossato)
+- [Guilherme Colasante Sgarbiero](https://github.com/guicola-sg)
 - [Guilherme Corazza Marques](https://github.com/guicmarques)
-- [Noel Viscome Eliezer](https://github.com/anor4k)
 - [Guilherme Fernandes](https://github.com/aateg)
-- [Lucas Leme](https://github.com/lucas-leme)
+- [Lucas Leme](https://github.com/lucas-leme)
+- [Noel Viscome Eliezer](https://github.com/anor4k)