Skip to content

Commit 40adc4b

Browse files
committed
README con opciones y ejemplos
1 parent 3b86127 commit 40adc4b

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

jobs-search-reporter/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Jobs Search Reporter
2+
3+
Un pequeño CLI para buscar trabajo con Github
4+
5+
---
6+
7+
## Descripcion
8+
9+
Nuestro pequeño CLI utilizara [la API de Github](https://jobs.github.com/) para buscar empleos.
10+
Para que nuestro CLI pueda funcionar debemos pasar algunas opciones/parametros de busqueda.
11+
12+
La manera de invocar a nuestro CLI sera:
13+
14+
```
15+
jobs-search [OPTIONS] <SKILL>
16+
```
17+
18+
Donde `[OPTIONS]` son:
19+
20+
```
21+
--location <UBICACION> # <UBICACION>: Algun lugar del mundo, tambien disponible como: -l
22+
--page <PAGINA> # <PAGINA>: Los resultados se muestran de 50 en 50, cada 50 resultados se le conoce como pagina empezando en 0. Default: 0. Tambien disponible como: -p
23+
--full-time # Si queremos que sean solo empleos de tiempo completo. default: false
24+
--markdown # Mostrar los resultados en Markdown
25+
```
26+
27+
Y `<SKILL>` es el tipo de skill del que queremos encontrar trabajos.
28+
29+
### Ejemplo
30+
31+
Para buscar trabajos de `Java` en Tokyo, usariamos:
32+
33+
`jobs-search --location tokyo java`

0 commit comments

Comments
 (0)