Skip to content

Commit

Permalink
fix: repo name
Browse files Browse the repository at this point in the history
  • Loading branch information
maxgfr committed Mar 7, 2022
1 parent c8bc6bf commit 4876120
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
File renamed without changes
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# binance-historic
# binance-history

Utility to retrieve historical data from Binance.

![Alt Text](https://raw.githubusercontent.com/maxgfr/binance-historic/main/.github/assets/binance-historic.gif)
![Alt Text](https://raw.githubusercontent.com/maxgfr/binance-history/main/.github/assets/main.gif)

## Usage

### With the cli

```sh
npm install -g binance-historic
binance-historic download
npm install -g binance-history
binance-history download
# or
npx binance-historic download
npx binance-history download
```

### With the library

```ts
import { getKline, Kline } from 'binance-historic';
import { getKline, Kline } from 'binance-history';

const result: Array<Kline> = await getKline(
'ETHUSDT',
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "binance-historic",
"name": "binance-history",
"version": "1.5.1",
"author": "maxgfr",
"license": "MIT",
Expand All @@ -17,12 +17,13 @@
"build"
],
"bin": {
"binance-historic": "./build/index.js"
"binance-history": "./build/index.js"
},
"keywords": [
"node",
"typescript",
"binance",
"history",
"historic",
"klines",
"download",
Expand Down
2 changes: 1 addition & 1 deletion src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export async function runCommand() {
const program = new Command();

program
.name('binance-historic')
.name('binance-history')
.description('Utility to download historical klines from binance');

program
Expand Down

0 comments on commit 4876120

Please sign in to comment.