Skip to content

Commit

Permalink
Update README (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
affonsobrian authored Dec 5, 2021
1 parent b7da103 commit 297afbf
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# Geld

A library to easily handle currency conversions
A library to easily handle currency conversions.


## Official documentation
- We do not have an official documentation yet, we are working on this.

## Data origin
Currently the API uses the https://theforexapi.com/api to get the values.
We are working to make it extensable so you can pick info from different sources in the future.


## How to install

```
pip install geld
```

## How to use the Sync Client

```
from geld.clients import sync_client as client
result = client.convert_currency("USD", "BRL", 25, "2021-12-05")
```

0 comments on commit 297afbf

Please sign in to comment.