currzy/README.md

Free, open-source library for fetching, managing, and converting up-to-date currency rates from multiple reliable sources with the ability to easily choose the source.

<div align="center">
  <h1>💸 Currzy — currency library 💸</h1>
</div>

💱 **Free, open-source library** for fetching, managing, and converting up-to-date currency rates from multiple reliable sources, with the ability to easily choose your provider.

> 📚 For more detailed documentation and advanced usage, visit [Currzy Docs](https://github.com/Currzy).

## Features

- Get current exchange rates for supported currencies.
- Convert amounts between different currencies.
- Cache rates locally to reduce API calls (cache expires after 1 hour).
- Clear the cache manually when needed.
- Easily switch between providers (e.g., `CBRF`).

## Installation
```bash
npm i currenzy-lib
```

## Usage
```javascript
import { Currzy } from "currzy";

async function main() {
  // Initialize with a provider
  const currzy = new Currzy("cbrf");

  // Get the rate of EUR to USD
  const rate = await currzy.getRate("EUR", "USD");
  console.log(`1 USD = ${rate.toFixed(4)} EUR`);

  // Convert 100 USD to EUR
  const converted = await currzy.convert(100, "USD", "EUR");
  console.log(`100 USD = ${converted.toFixed(2)} EUR`);

  // Get all rates relative to USD
  const allRates = await currzy.getAllRatesTo("USD");
  console.log(allRates);

  // Get last update date
  console.log("Last update:", currzy.getLastUpdate());

  // Clear cache manually
  await currzy.clearCache();
  console.log("Cache cleared.");
}

main();
```

## Notes
- Each provider may have its own methods
- Rates are cached locally for <strong>1 hour</strong> to minimize API requests.
- Cache can be cleared manually via ```currzy.clearCache()```

## Supported Currencies (CbrfProvider)
| AUD | AZN | DZD | GBP | AMD | BHD | BYN | BGN | BOB | BRL |
|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|
| HUF | VND | HKD | GEL | DKK | AED | USD | EUR | EGP | INR |
| IDR | IRR | KZT | CAD | QAR | KGS | CNY | CUP | MDL | MNT |
| NGN | NZD | NOK | OMR | PLN | SAR | RON | XDR | SGD | TJS |
| THB | BDT | TRY | TMT | UZS | UAH | CZK | SEK | CHF | ETB |
| RSD | ZAR | KRW | JPY | MMK | RUB |     |     |     |     |