Skip to content

Commit

Permalink
adds instruction for installation and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
ivoputzer committed Jan 23, 2019
1 parent 51f5e19 commit 36f1ff3
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,16 @@ Cryptocurrency [ASCII](https://it.wikipedia.org/wiki/ASCII) symbols.
[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge&colorB=007EC6)](https://spdx.org/licenses/MIT)
[![minzip](https://img.shields.io/bundlephobia/minzip/crypto-symbols.svg?style=for-the-badge)](https://bundlephobia.com/scan-results?packages=crypto-symbols)
[![downloads](https://img.shields.io/npm/dt/crypto-symbols.svg?style=for-the-badge&colorB=007EC6)](https://www.npmjs.com/package/crypto-symbols)

## Install
```sh
npm install crypto-symbols
```

## Usage
```js
const { BTC, EUR } = require('crypto-symbols')

console.log(BTC) // "₿"
console.log(EUR) // "€"
```

0 comments on commit 36f1ff3

Please sign in to comment.