docs: Adiciona vídeo à documentação

README.Rmd

@@ -33,27 +33,34 @@ remotes::install_github("jjesusfilho/stf")
 
 ## Como usar
 
-Para baixar acórdãos e decisões monocráticas com termos de busca, use a função `stf_download_cjsg`. Se, por exemplo, você quiser baixar decisões com os termos "mulher, violência e gênero", proceda da seguinte forma:
+
+Para baixar acórdãos e decisões monocráticas com termos de busca, use a função `stf_baixar_cjsg`. Se, por exemplo, você quiser baixar decisões com os termos "mulher, violência e gênero", proceda da seguinte forma:
 
 ```r
 library(stf)
 
 dir.create("juris_stf")
 
-stf_download_cjsg("mulher AND violência AND gênero", 
+stf_baixar_cjsg("mulher AND violência AND gênero", 
                   base = "acordaos",
-                  size = 20, ## baixará 20 acórdãos por vez. 
+                  tamanho = 20, ## baixará 20 acórdãos por vez. 
                   dir = "juris_stf")
 
 ```
-Eu usei size = 20, mas você pode aumentar o número de decisões por arquivo para até 200.
+Eu usei tamanho = 20, mas você pode aumentar o número de decisões por arquivo para até 200.
 
 Depois disso, você pode ler esses acórdãos com a função `stf_read_cjsg`:
 
 ```r
-df <- stf_read_cjsg(dir = "juris_stf")
+df <- stf_ler_cjsg(dir = "juris_stf")
 ```
 
+### Coleta customizada
+
+O vídeo abaixo mostra a melhor forma de customizar sua busca.
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/mQDpUEQ37N4?si=4PdfNih8oYNHzY3X" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+
 
 
 

README.md

@@ -9,7 +9,7 @@
 ## Objetivo
 
 Inicialmente, as funções e o manual estavam em inglês. No entanto,
-decidi passar o manual para português. As funções permanecem em inglês, por
+decidi passar o manual para inglês. As funções permanecem em inglês, por
 ora. Este pacote contêm funções tanto para baixar a jurisprudência por
 termos, quanto possibilita baixar toda a base do STF.
 
@@ -26,25 +26,32 @@ remotes::install_github("jjesusfilho/stf")
 ## Como usar
 
 Para baixar acórdãos e decisões monocráticas com termos de busca, use a
-função `stf_download_cjsg`. Se, por exemplo, você quiser baixar decisões
+função `stf_baixar_cjsg`. Se, por exemplo, você quiser baixar decisões
 com os termos “mulher, violência e gênero”, proceda da seguinte forma:
 
 ``` r
 library(stf)
 
 dir.create("juris_stf")
 
-stf_download_cjsg("mulher AND violência AND gênero", 
+stf_baixar_cjsg("mulher AND violência AND gênero", 
                   base = "acordaos",
-                  size = 20, ## baixará 20 acórdãos por vez. 
+                  tamanho = 20, ## baixará 20 acórdãos por vez. 
                   dir = "juris_stf")
 ```
 
-Eu usei size = 20, mas você pode aumentar o número de decisões por
+Eu usei tamanho = 20, mas você pode aumentar o número de decisões por
 arquivo para até 200.
 
 Depois disso, você pode ler esses acórdãos com a função `stf_read_cjsg`:
 
 ``` r
-df <- stf_read_cjsg(dir = "juris_stf")
+df <- stf_ler_cjsg(dir = "juris_stf")
 ```
+
+### Coleta customizada
+
+O vídeo abaixo mostra a melhor forma de customizar sua busca.
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/mQDpUEQ37N4?si=4PdfNih8oYNHzY3X" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen>
+</iframe>