aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 462c01245c91cb35bd3b70e4b8940b9f5695be50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# countryfetch

A cli tool for fetching information about countries. It uses https://restcountries.com/ API for backend.

## dependencies

[DENO](https://deno.land/)

## usage

```bash
deno run --allow-all /path/to/program/main.ts <arguments>
```

available arguments:

- `find <country-name>` - Find country information by name. Country names cannot have whitespaces, use kebab-case or snake_case instead.
- `sync` - Synchronizes databes, stores it in localStorage. This is done automatically, but can be triggered manually.
- `random` - Get random country information.

## Issues

- App will not match names that include "-", which is replaced by whitespace by program.