Skip to content

Commit c51cd21

Browse files
committed
update docs
1 parent 21ffc75 commit c51cd21

File tree

30 files changed

+201
-175
lines changed

30 files changed

+201
-175
lines changed

packages/bitcore-build/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
Install with:
88

99
```sh
10-
npm install bitcore-build
10+
npm install @bitpay-labs/bitcore-build
1111
```
1212

1313
And use and require in your gulp file:
1414

1515
```javascript
1616
var gulp = require('gulp');
17-
var bitcoreTasks = require('bitcore-build');
17+
var bitcoreTasks = require('@bitpay-labs/bitcore-build');
1818

1919
bitcoreTasks('submodule');
2020
gulp.task('default', ['lint', 'test', 'browser', 'coverage']);
@@ -26,7 +26,7 @@ gulp.task('default', ['lint', 'test', 'browser', 'coverage']);
2626
- If the module is node-only, avoid adding the browser tasks with:
2727

2828
```javascript
29-
var bitcoreTasks = require('bitcore-build');
29+
var bitcoreTasks = require('@bitpay-labs/bitcore-build');
3030
bitcoreTasks('submodule', {skipBrowsers: true});
3131
```
3232

packages/bitcore-cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bitcore CLI
22

3-
[![NPM Package](https://img.shields.io/npm/v/bitcore-wallet.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-wallet)
3+
[![NPM Package](https://img.shields.io/npm/v/@bitpay-labs/bitcore-cli.svg?style=flat-square)](https://www.npmjs.org/package/@bitpay-labs/bitcore-cli)
44

55
**A simple Command Line Interface Wallet using [Bitcore Wallet Service](https://github.com/bitpay/bitcore/tree/master/packages/bitcore-wallet-service) and its *official* client lib [Bitcore Wallet Client](https://github.com/bitpay/bitcore/tree/master/packages/bitcore-wallet-client).**
66

packages/bitcore-lib-cash/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bitcore Lib Cash
22

3-
[![NPM Package](https://img.shields.io/npm/v/bitcore-lib-cash.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-lib-cash)
3+
[![NPM Package](https://img.shields.io/npm/v/@bitpay-labs/bitcore-lib-cash.svg?style=flat-square)](https://www.npmjs.org/package/@bitpay-labs/bitcore-lib-cash)
44
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/bitpay/bitcore/tree/master.svg?style=shield&task=bitcore-lib-cash)](https://dl.circleci.com/status-badge/redirect/gh/bitpay/bitcore/tree/master)
55
[![Coverage Status](https://coveralls.io/repos/github/bitpay/bitcore-lib-cash/badge.svg?branch=master&path=packages/bitcore-lib-cash)](https://coveralls.io/github/bitpay/bitcore-lib-cash)
66

@@ -17,15 +17,15 @@ Bitcoin cash uses a different `sighash` for transaction signatures. The implemen
1717
## Get Started
1818

1919
```sh
20-
npm install bitcore-lib-cash
20+
npm install @bitpay-labs/bitcore-lib-cash
2121
```
2222

23-
Adding Bitcore Cash to your app's `package.json`:
23+
24+
Or manually add Bitcore Cash to your app's `package.json`:
2425

2526
```json
2627
"dependencies": {
27-
"bitcore-lib-cash": "=0.18.0",
28-
...
28+
"@bitpay-labs/bitcore-lib-cash": "^11.5.1",
2929
}
3030
```
3131

packages/bitcore-lib-cash/docs/browser.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Bitcore and most official submodules work in the browser, thanks to [browserify](http://browserify.org/) (some modules are not fully compatible with web browsers).
44

5-
The easiest and recommended way to use them, is via [Bower](http://bower.io/), a browser package manager, and get the release bundles. For example, when building an app that uses `bitcore` and `bitcore-mnemonic`, you do:
5+
The easiest and recommended way to use them, is via [Bower](http://bower.io/), a browser package manager, and get the release bundles. For example, when building an app that uses `bitcore-lib` and `bitcore-mnemonic`, you do:
66

77
```sh
8-
bower install bitcore-lib
9-
bower install bitcore-mnemonic
8+
bower install @bitpay-labs/bitcore-lib
9+
bower install @bitpay-labs/bitcore-mnemonic
1010
```
1111

1212
You can also use a `bower.json` file to store the dependencies of your project:
@@ -17,8 +17,8 @@ You can also use a `bower.json` file to store the dependencies of your project:
1717
"version": "0.0.1",
1818
"license": "MIT",
1919
"dependencies": {
20-
"bitcore-lib": "^0.13.7",
21-
"bitcore-mnemonic": "^1.0.1"
20+
"@bitpay-labs/bitcore-lib": "^11.5.1",
21+
"@bitpay-labs/bitcore-mnemonic": "^11.5.1"
2222
}
2323
}
2424
```
@@ -40,8 +40,8 @@ After this, you can include the bundled release versions in your HTML file:
4040
<body>
4141

4242
<script type="text/javascript">
43-
var bitcore = require('bitcore-lib');
44-
var Mnemonic = require('bitcore-mnemonic');
43+
var bitcore = require('@bitpay-labs/bitcore-lib');
44+
var Mnemonic = require('@bitpay-labs/bitcore-mnemonic');
4545
// etc...
4646
</script>
4747

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Bitcore lib for doge. See bitcore-lib-litecoin for details.
1+
Bitcore lib for doge. See bitcore-lib-ltc for details.
22
=======

packages/bitcore-lib-ltc/docs/browser.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Browser Builds
2-
Litecore and most official submodules work in the browser, thanks to [browserify](http://browserify.org/) (some modules are not fully compatible with web browsers).
2+
Bitcore-lib-ltc and most official submodules work in the browser, thanks to [browserify](http://browserify.org/) (some modules are not fully compatible with web browsers).
33

4-
The easiest and recommended way to use them, is via [Bower](http://bower.io/), a browser package manager, and get the release bundles. For example, when building an app that uses `litecore` and `bitcore-mnemonic`, you do:
4+
The easiest and recommended way to use them, is via [Bower](http://bower.io/), a browser package manager, and get the release bundles. For example, when building an app that uses `bitcore-lib-ltc` and `bitcore-mnemonic`, you do:
55

66
```sh
7-
bower install litecore-lib
8-
bower install bitcore-mnemonic
7+
bower install @bitpay-labs/bitcore-lib-ltc
8+
bower install @bitpay-labs/bitcore-mnemonic
99
```
1010

1111
You can also use a `bower.json` file to store the dependencies of your project:
@@ -16,8 +16,8 @@ You can also use a `bower.json` file to store the dependencies of your project:
1616
"version": "0.0.1",
1717
"license": "MIT",
1818
"dependencies": {
19-
"litecore-lib": "^0.13.7",
20-
"bitcore-mnemonic": "^1.0.1"
19+
"@bitpay-labs/bitcore-lib-ltc": "^11.5.1",
20+
"@bitpay-labs/bitcore-mnemonic": "^11.5.1"
2121
}
2222
}
2323
```
@@ -32,15 +32,15 @@ After this, you can include the bundled release versions in your HTML file:
3232

3333
<head>
3434
<meta charset="utf-8">
35-
<script src="bower_components/litecore/litecore-lib.min.js"></script>
35+
<script src="bower_components/bitcore-lib-ltc/bitcore-lib.min.js"></script>
3636
<script src="bower_components/bitcore-mnemonic/bitcore-mnemonic.min.js"></script>
3737
</head>
3838

3939
<body>
4040

4141
<script type="text/javascript">
42-
var litecore = require('litecore-lib');
43-
var Mnemonic = require('bitcore-mnemonic');
42+
var litecore = require('@bitpay-labs/bitcore-lib-ltc');
43+
var Mnemonic = require('@bitpay-labs/bitcore-mnemonic');
4444
// etc...
4545
</script>
4646

@@ -53,11 +53,11 @@ After this, you can include the bundled release versions in your HTML file:
5353
If you want to use a specific version of a module, instead of a release version (not recommended), you must run browserify yourself. You can get a minified browser bundle by running the following on the project root folder.
5454

5555
```sh
56-
browserify --require ./index.js:litecore-lib | uglifyjs > litecore-lib.min.js
56+
browserify --require ./index.js:bitcore-lib | uglifyjs > bitcore-lib.min.js
5757
```
5858

5959
```sh
60-
browserify --require ./index.js:bitcore-mnemonic --external litecore-lib | uglifyjs > bitcore-mnemonic.min.js
60+
browserify --require ./index.js:bitcore-mnemonic --external bitcore-lib | uglifyjs > bitcore-mnemonic.min.js
6161
```
6262

6363
In many of the modules you can also run the command to build a browser bundle:

packages/bitcore-lib/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bitcore JavaScript Library for Bitcoin
22

3-
[![NPM Package](https://img.shields.io/npm/v/bitcore-lib.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-lib)
3+
[![NPM Package](https://img.shields.io/npm/v/@bitpay-labs/bitcore-lib.svg?style=flat-square)](https://www.npmjs.org/package/@bitpay-labs/bitcore-lib)
44
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/bitpay/bitcore/tree/master.svg?style=shield&task=bitcore-lib)](https://dl.circleci.com/status-badge/redirect/gh/bitpay/bitcore/tree/master)
55
[![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-lib.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-lib)
66

packages/bitcore-lib/docs/browser.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Bitcore Javascript Library and most official submodules work in the browser, tha
55
The easiest and recommended way to use them, is via [Bower](http://bower.io/), a browser package manager, and get the release bundles. For example, when building an app that uses `bitcore-lib` and `bitcore-mnemonic`, you do:
66

77
```sh
8-
bower install bitcore-lib
9-
bower install bitcore-mnemonic
8+
bower install @bitpay-labs/bitcore-lib
9+
bower install @bitpay-labs/bitcore-mnemonic
1010
```
1111

1212
You can also use a `bower.json` file to store the dependencies of your project:
@@ -17,8 +17,8 @@ You can also use a `bower.json` file to store the dependencies of your project:
1717
"version": "0.0.1",
1818
"license": "MIT",
1919
"dependencies": {
20-
"bitcore-lib": "^0.13.7",
21-
"bitcore-mnemonic": "^1.0.1"
20+
"@bitpay-labs/bitcore-lib": "^11.5.1",
21+
"@bitpay-labs/bitcore-mnemonic": "^11.5.1"
2222
}
2323
}
2424
```
@@ -40,8 +40,8 @@ After this, you can include the bundled release versions in your HTML file:
4040
<body>
4141

4242
<script type="text/javascript">
43-
var bitcore = require('bitcore-lib');
44-
var Mnemonic = require('bitcore-mnemonic');
43+
var bitcore = require('@bitpay-labs/bitcore-lib');
44+
var Mnemonic = require('@bitpay-labs/bitcore-mnemonic');
4545
// etc...
4646
</script>
4747

packages/bitcore-lib/docs/unit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ To understand the need of using the `Unit` class when dealing with unit conversi
77
```javascript
88
> 81.99 * 100000 // wrong
99
8198999.999999999
10-
> var bitcore = require('bitcore-lib');
10+
> var bitcore = require('@bitpay-labs/bitcore-lib');
1111
> var Unit = bitcore.Unit;
1212
> Unit.fromMilis(81.99).toSatoshis() // correct
1313
8199000

packages/bitcore-mnemonic/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
BIP39 Mnemonics for bitcore
44

5-
[![NPM Package](https://img.shields.io/npm/v/bitcore-mnemonic.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-mnemonic)
5+
[![NPM Package](https://img.shields.io/npm/v/@bitpay-labs/bitcore-mnemonic.svg?style=flat-square)](https://www.npmjs.org/package/@bitpay-labs/bitcore-mnemonic)
66
[![Build Status](https://img.shields.io/travis/bitpay/bitcore-mnemonic.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-mnemonic)
77
[![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-mnemonic.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-mnemonic)
88

@@ -13,14 +13,13 @@ BIP39 Mnemonics for bitcore
1313
This library is distributed in both the npm packaging systems.
1414

1515
```sh
16-
npm install bitcore-lib #this to install bitcore-lib since it is a peerDependecy
17-
npm install bitcore-mnemonic
16+
npm install @bitpay-labs/bitcore-mnemonic
1817
```
1918

2019
There are many examples of how to use it on the developer guide [section for mnemonic](./docs/index.md). For example, the following code would generate a new random mnemonic code and convert it to a `HDPrivateKey`.
2120

2221
```javascript
23-
var Mnemonic = require('bitcore-mnemonic');
22+
var Mnemonic = require('@bitpay-labs/bitcore-mnemonic');
2423
var code = new Mnemonic(Mnemonic.Words.SPANISH);
2524
code.toString(); // natal hada sutil año sólido papel jamón combate aula flota ver esfera...
2625
var xpriv = code.toHDPrivateKey();

0 commit comments

Comments
 (0)