From 0ea04a67fee099367d02de5a66b6fa983f4ad278 Mon Sep 17 00:00:00 2001
From: Joao Meyer <1994meyer@gmail.com>
Date: Sat, 13 Apr 2024 19:45:08 -0300
Subject: [PATCH] Added development info

---
 .env.example | 21 ++++++++++++++++++++
 README.md    | 55 +++++++++++++++++++++++++++++++++++-----------------
 2 files changed, 58 insertions(+), 18 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..ec92c29
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,21 @@
+# Generate a secret using: `openssl rand -hex 32``
+NUXT_SECRET=MY-SECRET
+
+# Needed for production
+#
+# Must be in the form:
+# - example.org
+# - domain.example.org
+#
+# For more info, please check:
+#   https://sidebase.io/nuxt-auth/resources/errors#auth_no_origin
+AUTH_ORIGIN=localhost:3000
+
+# Auth0 credentials
+# 
+# In your Auth0 dashboard: Application > Basic Information > Domain
+AUTH0_ISSUER=https://YOUR-DOMAIN.us.auth0.com
+# In your Auth0 dashboard: Application > Basic Information > Client ID
+AUTH0_CLIENT_ID=YOUR-CLIENT-ID
+# In your Auth0 dashboard: Application > Basic Information > Client Secret
+AUTH0_CLIENT_SECRET=YOUR-CLIENT-SECRET
\ No newline at end of file
diff --git a/README.md b/README.md
index a182886..3b0cc95 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,54 @@
 # Findicadores
 
-Disponível em: [findicadores.com.br](https://findicadores.com.br)
+Website using data from [Fintz][1]
 
-## Sobre o site
+## About
 
-Busque uma ação e acesse rapidamente:
+Currently, you can access the following information using the website:
 
-- indicadores
-- resultado
-- cotação
-- gráficos de cada um desses
+- Indexes
+- Results
+- Ticker prices
+- Graphs for all of the above
 
-### Exemplo com PETR4
+### Examples
+
+General data:
 
-Dados gerais
 ![PETR4.png](src/assets/PETR4.png)
 
-Gráfico Histórico (só clicar no indicador)
+Historical graph (click on index)
+
 ![PETR4.png](src/assets/PETR4_LPA.png)
 
-## Rodar local
+## Development
+
+Install dependencies using:
+
+```bash
+npm install
+```
+
+In order to run the application locally, you will need to copy the example
+`.env` file and replace the values with your own:
+
+```bash
+cp -v .env.example .env
+```
 
-### Instalar
+Finally, you can run the development server using:
 
-`npm install`
+```bash
+npm run dev
+```
 
-### Rodar
+## Deploy
 
-`npm run dev`
+We deploy to [Vercel][2]. So you just need to run:
 
-### Deployar
+```bash
+npx vercel
+```
 
-`npm run build`
-`npm run deploy` // script customizado do pacote gh-pages
+[1]: https://fintz.com.br
+[2]: https://vercel.com