Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
markpenovich committed Feb 16, 2019
1 parent 100af78 commit e0a70ac
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
Expand Up @@ -17,11 +17,13 @@ Require package into project
require('cryptocurrency-unit-convert')
```

There are 4 methods:
There are 6 methods:
- `convertBTC(value, fromUnit, toUnit)`
- `convertETH(value, fromUnit, toUnit)`
- `convertXRP(value, fromUnit, toUnit)`
- `convertLTC(value, fromUnit, toUnit)`
- `convertDASH(value, fromUnit, toUnit)`
- `convertZEC(value, fromUnit, toUnit)`

## Examples
```javascript
Expand Down Expand Up @@ -50,6 +52,18 @@ const convertedLTC = Units.convertLTC('1', 'photon', 'ltc') // '0.00000001'

// Convert 1.5 ltc to photon
const convertedLTC = Units.convertLTC('1.5', 'ltc', 'photon') // '150000000'

// Convert 1 duff to dash
const convertedDASH = Units.convertDASH('1', 'duff', 'dash') // '0.00000001'

// Convert 1.5 dash to duff
const convertedDASH = Units.convertDASH('1.5', 'dash', 'duff') // '150000000'

// Convert 1 zatoshi to zec
const convertedZEC = Units.convertZEC('1', 'zatoshi', 'zec') // '0.00000001'

// Convert 1.5 zec to zatoshi
const convertedZEC = Units.convertZEC('1.5', 'zec', 'zatoshi') // '150000000'
```

## Units
Expand All @@ -69,6 +83,14 @@ drop, xrp

litoshi, photon, lite, ltc

#### Dash

duff, dash

#### Zcash

zatoshi, zec

### Want more currencies?

Email mark@telx.tech with the currency name, units, and unit names or submit a pull request. Currency list can be found in Units.json
Expand Down

0 comments on commit e0a70ac

Please sign in to comment.