Skip to content

Commit 2fa21bb

Browse files
Updated: Package Usage
1 parent fda7a14 commit 2fa21bb

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,33 @@
11
# fast-currency-transformer
2-
The Fastest NPM Package to transform data from one currency to another
2+
The Fastest NPM Package to transform data from one currency to another
33

4-
# How to use this package?
4+
# Installation
55

6-
Convert Currency:
6+
```shell
7+
npm i fast-currency-transformer
8+
```
9+
10+
# Usage
11+
12+
- `fromCurrency` -> Takes the currency you want to convert `from`.
13+
- `toCurrency` -> Takes the currency you want to convert `to`.
14+
- value -> Takes the value / units of `fromCurrency`.
15+
16+
It will return the converted live currency value based on the real-time currency conversion data.
17+
18+
### Convert Currency:
719

820
```js
21+
import { convertCurrency } from "fast-currency-transformer";
22+
923
convertCurrency("fromCurrency", "toCurrency", value) // value: The value of the currency you want to convert from.
1024
```
1125

1226

13-
Example Use-Case:
27+
### Example Use-Case:
1428

1529
```js
30+
import { convertCurrency } from "fast-currency-transformer";
31+
1632
convertCurrency("INR", "USD", 58700) // It will convert Rs. 58700 INR into Latest value of $ USD
1733
```

0 commit comments

Comments
 (0)