From 81d9bb413f40b7d9bf711b859b33d19472b239de Mon Sep 17 00:00:00 2001 From: Benny Neugebauer Date: Thu, 22 Oct 2020 13:11:58 +0200 Subject: [PATCH] chore: Rename branch 'master' to 'main' (#285) --- .github/dependabot.yml | 2 +- README.md | 14 +++++++------- package.json | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 56fae579..28561770 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,7 +6,7 @@ updates: interval: weekly pull-request-branch-name: separator: '-' - target-branch: master + target-branch: main commit-message: prefix: chore include: scope diff --git a/README.md b/README.md index f23888aa..665a5e58 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Coinbase Pro API -![Language Details](https://img.shields.io/github/languages/top/bennyn/coinbase-pro-node) ![Code Coverage](https://img.shields.io/codecov/c/github/bennyn/coinbase-pro-node/master) ![License](https://img.shields.io/npm/l/coinbase-pro-node.svg) ![Package Version](https://img.shields.io/npm/v/coinbase-pro-node.svg) ![Dependency Updates](https://img.shields.io/david/bennyn/coinbase-pro-node.svg) +![Language Details](https://img.shields.io/github/languages/top/bennyn/coinbase-pro-node) ![Code Coverage](https://img.shields.io/codecov/c/github/bennyn/coinbase-pro-node/main) ![License](https://img.shields.io/npm/l/coinbase-pro-node.svg) ![Package Version](https://img.shields.io/npm/v/coinbase-pro-node.svg) ![Dependency Updates](https://img.shields.io/david/bennyn/coinbase-pro-node.svg) [Coinbase Pro][1] API for Node.js, written in TypeScript and covered by tests. @@ -13,7 +13,7 @@ The purpose of [coinbase-pro-node][5] is to continue an active **Coinbase Pro AP - **Typed.** Source code is 100% TypeScript. No need to install external typings. - **Tested.** Code coverage is 100%. No surprises when using "coinbase-pro-node". - **Convenient.** Request throttling is built-in. Don't worry about rate limiting. -- **Comfortable.** More than an API client. You will get extras like [candle watching](https://github.com/bennyn/coinbase-pro-node/blob/master/src/demo/rest-watch-candles.ts). +- **Comfortable.** More than an API client. You will get extras like [candle watching](https://github.com/bennyn/coinbase-pro-node/blob/main/src/demo/rest-watch-candles.ts). - **Maintained.** Automated security updates. No threats from outdated dependencies. - **Documented.** Get started with [demo scripts][3] and [generated documentation][4]. - **Modern.** HTTP client with Promise API. Don't lose yourself in callback hell. @@ -82,18 +82,18 @@ client.rest.account.listAccounts().then(accounts => { If you want to listen to WebSocket messages, have a look at these demo scripts: -- [Subscribe to "ticker" channel (real-time price updates)](https://github.com/bennyn/coinbase-pro-node/blob/master/src/demo/websocket-ticker.ts) -- [Subscribe to authenticated "user" channel](https://github.com/bennyn/coinbase-pro-node/blob/master/src/demo/websocket-user.ts) +- [Subscribe to "ticker" channel (real-time price updates)](https://github.com/bennyn/coinbase-pro-node/blob/main/src/demo/websocket-ticker.ts) +- [Subscribe to authenticated "user" channel](https://github.com/bennyn/coinbase-pro-node/blob/main/src/demo/websocket-user.ts) ### Demos -All [demo scripts][3] are executable from the root directory. If you want to use specific credentials with a demo script, simply add a `.env` file to the root of this package to [modify environment variables](https://github.com/motdotla/dotenv/tree/v8.2.0#usage) used in [init-client.ts](https://github.com/bennyn/coinbase-pro-node/blob/master/src/demo/init-client.ts). +All [demo scripts][3] are executable from the root directory. If you want to use specific credentials with a demo script, simply add a `.env` file to the root of this package to [modify environment variables](https://github.com/motdotla/dotenv/tree/v8.2.0#usage) used in [init-client.ts](https://github.com/bennyn/coinbase-pro-node/blob/main/src/demo/init-client.ts). ```bash npx ts-node ./src/demo/dump-candles.ts ``` -**Tip:** There is a [.env.defaults](https://github.com/bennyn/coinbase-pro-node/blob/master/.env.defaults) file which serves as a template. Just remove its `.defaults` extension and enter your credentials to get started. Do not commit this file (or your credentials) to any repository! +**Tip:** There is a [.env.defaults](https://github.com/bennyn/coinbase-pro-node/blob/main/.env.defaults) file which serves as a template. Just remove its `.defaults` extension and enter your credentials to get started. Do not commit this file (or your credentials) to any repository! ### Real-world examples @@ -131,7 +131,7 @@ If you like this project, you might also like these related projects: [1]: https://pro.coinbase.com/ [2]: https://docs.pro.coinbase.com/ -[3]: https://github.com/bennyn/coinbase-pro-node/tree/master/src/demo +[3]: https://github.com/bennyn/coinbase-pro-node/tree/main/src/demo [4]: https://benny.work/coinbase-pro-node [5]: https://www.npmjs.com/package/coinbase-pro-node [6]: https://github.com/bennyn/coinbase-pro-node/network/dependents diff --git a/package.json b/package.json index 5c8e9b91..0be55258 100644 --- a/package.json +++ b/package.json @@ -95,7 +95,7 @@ "lint:types": "tsc --noEmit", "postversion": "git push origin && git push origin --tags && npm publish", "prettier": "prettier --ignore-path .gitignore --loglevel silent \"**/*.{html,json,scss,yml}\"", - "preversion": "git checkout master && git pull && yarn install && yarn lint && yarn test && yarn dist", + "preversion": "git checkout main && git pull && yarn install && yarn lint && yarn test && yarn dist", "release:major": "generate-changelog -M && yarn changelog:commit && yarn docs:release && npm version major", "release:minor": "generate-changelog -m && yarn changelog:commit && yarn docs:release && npm version minor", "release:patch": "generate-changelog -p && yarn changelog:commit && yarn docs:release && npm version patch",