Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dleitee committed Feb 18, 2017
1 parent e03ba21 commit 3dad3da
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Create a new Wallet object with the initial value.
- *{number}* **value** - The value to put on wallet
- *{number}* [**locale**=en] - The locale for this wallet
- *{number}* [**currency**=USD] - The currency to use in currency formatting.
- *{number}* [**currencyFractionals**=2] - The currency fractionals to use in currency formatting

```javascript
import Wallet from 'walletjs'
Expand All @@ -38,6 +39,7 @@ Create a new Wallet object with the initial value.
- *{number}* **value** - A value to put on wallet
- *{number}* [**locale**=en] - The locale for this wallet
- *{number}* [**currency**=USD] - The currency to use in currency formatting.
- *{number}* [**currencyFractionals**=2] - The currency fractionals to use in currency formatting

```javascript
import Wallet from 'walletjs'
Expand All @@ -50,6 +52,7 @@ Create a new Wallet object from String value
- *{string}* **value** - A value to put on wallet
- *{number}* [**locale**=en] - The locale for this wallet
- *{number}* [**currency**=USD] - The currency to use in currency formatting.
- *{number}* [**currencyFractionals**=2] - The currency fractionals to use in currency formatting

```javascript
import Wallet from 'walletjs'
Expand Down
1 change: 1 addition & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export default class Wallet {
* @param {number} value - A value to put on wallet
* @param {number} [locale=en] - The locale for this wallet
* @param {number} [currency=USD] - The currency to use in currency formatting.
* @param {number} [currencyFractionals=2] - The currency fractionals to use in currency formatting
* @return {Wallet} The wallet with value
*/
static init = (value = 0, { ...options } = {}) => new Wallet(value, options)
Expand Down

0 comments on commit 3dad3da

Please sign in to comment.