From ef20913e3bb403ae46c5780fe6b6a560cb0c4479 Mon Sep 17 00:00:00 2001
From: gabriel giovanini <1408882-gabrielgio@users.noreply.gitlab.com>
Date: Wed, 23 Mar 2022 23:39:57 +0000
Subject: feat: Adiciona documentacao

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f13190d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# Nerdcast filtro para podcast
+
+Um simples filtro para o Nerdcast. Hoje em dia o _feed_ do _podcast_ e bem
+poluído, vários temas, quadros e programas. Esse projeto e um filtro simples
+para tirar alguns programas do _feed_ ou mesmo dividi-los em _feeds_
+diferentes. Os seguintes seguimentos são suportados:
+
+- `nerdcast`
+- `empreendedor`
+- `mamicas`
+- `english`
+- `nerdcash`
+- `bunker`
+- `tech`
+- `genera`
+
+## Para usuarios
+
+Por padrão ele só pega a série principal lançada toda sexta. Para usar basta 
+adicionar a seguinte URL no seu agregador:
+
+```
+https://jnfilter.herokuapp.com/
+```
+
+Mas caso você queira, você pode escolher mais alguns seguimentos. Por exemplo,
+se voce quer ver somente a série principal e canecas de mamicas você
+adicionaria o seguinte URL no seu agregador:
+
+```
+https://jnfilter.herokuapp.com/?q=mamicas,nerdcast
+```
+
+Quer nerdcast e nerdcash? 
+
+```
+https://jnfilter.herokuapp.com/?q=nerdcash,nerdcast
+```
+
+E por aí vai, seguindo os seguimentos listados acima.
+
+## Para programadores
+
+E um projeto simples feito em cima do FastApi. Ele vai pegar o _feed_ e 
+filtrar os itens do _feed_ do podcast. Não tem cache nem nada sendo armazenado,
+todo processamento e feito a partir do feed para cada requisição.
+
+Para rodar basta instalar os requirements e rodar o seguinte código:
+
+```shell
+uvicorn main:app --host=0.0.0.0
+```
+
+E você já pode apontar o seu agregador favorito para sua maquina.
+
-- 
cgit v1.2.3