Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 5, 2019
1 parent d3f5482 commit fe1229e
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 203 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 Bloggify <[email protected]> (https://bloggify.org)
Copyright (c) 2016-19 Bloggify <[email protected]> (https://bloggify.org)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
64 changes: 52 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,52 @@

















# bnr

[![Version](https://img.shields.io/npm/v/bnr.svg)](https://www.npmjs.com/package/bnr) [![Downloads](https://img.shields.io/npm/dt/bnr.svg)](https://www.npmjs.com/package/bnr)
Access resources (e.g. exchange rates) provided by the National Bank of Romania.

> Access resources (e.g. exchange rates) provided by the National Bank of Romania.

## :cloud: Installation


## Installation

```sh
$ npm i --save bnr
$ npm i bnr
```


## :clipboard: Example







## Example






```js
const bnr = require("bnr");
"use strict";

const bnr = require("..");

// Get the currency rates
bnr.getRates((err, rates) => {
Expand Down Expand Up @@ -64,9 +93,18 @@ bnr.convert(100, "EUR", "USD", function (err, amount, output) {
// Result: 107.72102819395911
// 100 EUR is 107.72102819395911 USD
});

```

## :memo: Documentation





## Documentation





### `getRates(cb)`
Expand All @@ -86,16 +124,18 @@ Convert currencies.



## :yum: How to contribute



## How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].



## :scroll: License
## License
See the [LICENSE][license] file.

[MIT][license] © [Bloggify][website]

[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2016#license-mit
[website]: https://bloggify.org
[license]: /LICENSE
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
190 changes: 1 addition & 189 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@
"cli.js",
"index.js"
]
}
}

0 comments on commit fe1229e

Please sign in to comment.