Skip to content

Commit 0dab4d7

Browse files
committed
docs: cleaning up the readme verbiage dx-2014
1 parent ca63a45 commit 0dab4d7

File tree

2 files changed

+20
-21
lines changed

2 files changed

+20
-21
lines changed

modules/bitgo/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
# BitGo JavaScript SDK
22

3-
The BitGo Platform and SDK makes it easy to build multi-signature crypto-currency applications today with support for Bitcoin, Ethereum and many other coins.
4-
The SDK is fully integrated with the BitGo co-signing service for managing all of your BitGo wallets.
3+
The BitGo Platform enables you to build multisignature and MPC cryptocurrency applications for over a thousand digital assets. You can view all BitGo supported assets on the [Developer Portal](https://assets.bitgo.com/coins). The SDK is fully integrated with the BitGo co-signing service for managing all of your BitGo wallets.
54

6-
Included in the SDK are examples for how to use the API to manage your multi-signature wallets.
5+
The SDK includes examples for how to use the API to manage your wallets.
76

8-
Please email us at support@bitgo.com if you have questions or comments about this API.
7+
If you have questions or comments about this API, email support@bitgo.com.
98

109
[![Known Vulnerabilities](https://snyk.io/test/github/BitGo/BitGoJS/badge.svg)](https://snyk.io/test/github/BitGo/BitGoJS)
1110
[![BitGo SDK](https://github.com/BitGo/BitGoJS/actions/workflows/ci.yml/badge.svg)](https://github.com/BitGo/BitGoJS/actions/workflows/ci.yml)
1211

1312
# Installation
1413

15-
Please make sure you are running at least Node version 20 (the latest LTS release is recommended) and NPM version 10.
16-
We recommend using `nvm`, the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation), for setting your Node version.
14+
Ensure you're running Node version 20 or higher (preferably the latest LTS release) and NPM version 10.
15+
For setting your Node version, we recommend using `nvm` - the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation).
1716

1817
`npm install --save bitgo`
1918

2019
# Full Documentation
2120

22-
For more general information about the BitGo API and various integration guides, please see our [Developer Portal](https://developers.bitgo.com/).
21+
For more comprehensive information about the BitGo API, including integration guides, see the BitGo [Developer Portal](https://developers.bitgo.com/).
2322

2423
# Release Notes
2524

26-
You can find the complete release notes (since version 4.44.0) [here](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/CHANGELOG.md).
25+
- [API changelog](https://github.com/BitGo/api-changelog/)
26+
- [SDK changelog](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/CHANGELOG.md) (since version 4.44.0)
2727

2828
# Example Usage
2929

30-
Examples and integration guides for BitGoJS or BitGo Express can be found in the [Developer Portal](https://developers.bitgo.com/guides/get-started/intro) or the [examples directory](https://github.com/BitGo/BitGoJS/tree/master/examples).
30+
You can view examples in the [examples directory](https://github.com/BitGo/BitGoJS/tree/master/examples). You can view integration guides in the [Developer Portal](https://developers.bitgo.com/guides/get-started/intro).
3131

3232
# Enabling additional debugging output
3333

3434
`bitgo` uses the `debug` package to emit extra information, which can be useful when debugging issues with BitGoJS or BitGo Express.
3535

36-
When using the `bitgo` npm package, the easiest way to enable debug output is by setting the `DEBUG` environment variable to one or more of the debug namespaces in the table below. Multiple debug namespaces can be enabled by giving a comma-separated list or by using `*` as a wildcard. See the [debug package documentation](https://github.com/visionmedia/debug#readme) for more details.
36+
When using the `bitgo` npm package, the easiest way to enable debug output is to set the `DEBUG` environment variable to one or more of the debug namespaces in the table below. You can enable multiple debug namespaces by using a comma-separated list or by using `*` as a wildcard. See the [debug package documentation](https://github.com/visionmedia/debug#readme) for more details.
3737

3838
## Available Debug Namespaces
3939

@@ -47,32 +47,32 @@ When using the `bitgo` npm package, the easiest way to enable debug output is by
4747
| `bitgo:v2:eth` | Ethereum specific output. Currently only failures to require the optional Ethereum libraries are reported |
4848
| `bitgo:v2:util` | SDK utilities specific output. Currently only failures to require the optional Ethereum libraries are reported |
4949

50-
Another debug namespace which is not provided by BitGoJS but is helpful nonetheless is the `superagent` namespace, which will output all HTTP requests and responses (only the URL, not bodies).
50+
Another debug namespace that BitGoJS doesn't provide but is helpful nonetheless is the `superagent` namespace. This outputs all HTTP requests and responses (only the URL, not bodies).
5151

5252
## Example
5353

54-
To run an SDK script with debug output enabled, export the DEBUG environment variable before running.
54+
To run an SDK script with debug output enabled, export the `DEBUG` environment variable before running.
5555

5656
```shell script
5757
export DEBUG='bitgo:*' # enable all bitgo debug namespaces
5858
node myScript.js
5959
```
6060

61-
To set debug namespaces in the browser, you should set `localStorage.debug` property instead of the `DEBUG` environment variable using your browser's development tools console.
61+
To set debug namespaces in a browser, set the `localStorage.debug` property instead of the `DEBUG` environment variable using your browser's development tools console.
6262

6363
```js
6464
localStorage.debug = 'bitgo:*'; // enable all bitgo debug namespaces
6565
```
6666

6767
# Using with TypeScript
6868

69-
`bitgo` is not yet compatible with the `noImplicitAny` compiler option. If you want to use this option in your project (and we recommend that you do), you must set the `skipLibCheck` option to supress errors about missing type definitions for dependencies of `bitgo`.
69+
`bitgo` is not yet compatible with the `noImplicitAny` compiler option. To use this option in your project (and we recommend that you do), you must set the `skipLibCheck` option to suppress errors about missing type definitions for dependencies of `bitgo`.
7070

71-
# Usage in Browser
71+
# Usage in browser
7272

73-
Since version 6, `bitgo` includes a minified, browser-compatible bundle by default at `dist/browser/BitGoJS.min.js`. It can be copied from there directly into your project.
73+
Since version 6, `bitgo` includes a minified, browser-compatible bundle by default at `dist/browser/BitGoJS.min.js`. You can copy the bundle from there and paste it directly into your project.
7474

75-
BitGoJS can also be bundled with any module bundler. There is a Webpack configuration file already included, which can be triggered with package scripts.
75+
You can also bundle BitGoJS with any module bundler. There's a Webpack configuration file already included, which you can use to trigger with package scripts.
7676

7777
For a production build: `npm run-script compile`
7878

modules/express/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
# BitGo Express Local Signing Server (REST API)
1+
# BitGo Express local signing server (REST API)
22

33
Suitable for developers working in a language without an official BitGo SDK.
44

5-
BitGo Express runs as a service in your own datacenter, and handles the client-side operations involving your own keys, such as partially signing transactions before submitting to BitGo.
6-
This ensures your keys never leave your network, and are not seen by BitGo. BitGo Express can also proxy the standard BitGo REST APIs, providing a unified interface to BitGo through a single REST API.
5+
BitGo Express runs as a service in your own datacenter, and handles the client-side operations involving your own keys, such as partially signing transactions before submitting to BitGo. This ensures your keys never leave your network, and are not seen by BitGo. BitGo Express can also proxy the standard BitGo REST APIs, providing a unified interface to BitGo through a single REST API.
76

87
# Documentation
98

10-
Comprehensive documentation on the APIs provided by BitGo Express can be found at our [Platform API Reference](https://app.bitgo.com/docs/#tag/Express).
9+
View the comprehensive documentation on the BitGo [Developer Portal](https://developers.bitgo.com/docs/get-started-express-install/).
1110

1211
# Running BitGo Express
1312

0 commit comments

Comments
 (0)