Skip to content
This repository was archived by the owner on Feb 21, 2024. It is now read-only.

Commit 8be0aa6

Browse files
chmaniechmanie
committed
Adjust all READMEs
1 parent 453ab2e commit 8be0aa6

File tree

5 files changed

+61
-57
lines changed

5 files changed

+61
-57
lines changed

‎README.md‎

Lines changed: 7 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ To use the **software wallet** (based on the [ethers wallet](https://github.com/
2525
#### Installation
2626

2727
```
28-
npm install @colony/purser-software
28+
npm install @purser/software
2929
```
3030

3131
#### Usage
3232

3333
Create a new wallet
3434

3535
```js
36-
import { create } from '@colony/purser-software'
36+
import { create } from '@purser/software'
3737

3838
const wallet = await create();
3939

@@ -43,48 +43,23 @@ console.log(wallet); // { address: '...', privateKey: '...', publicKey: '...' }
4343
or open an existing one (based on the mnemnonic)
4444

4545
```js
46-
import { open } from '@colony/purser-software'
46+
import { open } from '@purser/software'
4747

4848
const wallet = await open({ mnemonic: '...' });
4949

5050
console.log(wallet); // { address: '...', privateKey: '...', publicKey: '...' }
5151
```
5252

53-
### Quickstart (hardware wallet)
54-
55-
For **hardware wallets** (let's use trezor in this example) do:
56-
57-
#### Installation
58-
59-
```
60-
npm install @colony/purser-trezor
61-
```
62-
63-
#### Usage
64-
65-
```js
66-
import { open } from '@colony/purser-trezor'
67-
68-
const wallet = await open();
69-
70-
console.log(wallet); // { address: '...', otherAddrresses: [...], publicKey: '...' }
71-
72-
wallet.setDefaultAddress(2); // Sets the current address to the third address in the list of `otherAddresses`
73-
74-
```
75-
7653
### Documentation
7754

78-
Please see the [documentation](https://docs.colony.io/purser/docs-overview) with detailed examples and explanations.
55+
Please see the [documentation](https://joincolony.github.io/purser/) with detailed examples and explanations.
7956

8057
### Packages
8158

8259
Purser is a monorepo consisting of a collection of Ethereum wallet libraries:
83-
- [`purser-core`](https://github.com/JoinColony/purser/blob/master/modules/node_modules/@colony/purser-core): A collection of `helpers`, `utils`, `validators` and `normalizers` to assist the individual purser modules.
84-
- [`purser-ledger`](https://github.com/JoinColony/purser/blob/master/modules/node_modules/@colony/purser-ledger): A `javascript` library to interact with a [Ledger](https://www.ledger.com/) based Ethereum wallet.
85-
- [`purser-metamask`](https://github.com/JoinColony/purser/blob/master/modules/node_modules/@colony/purser-metamask): A `javascript` library to interact with the a [Metamask](https://metamask.io/) based Ethereum wallet.
86-
- [`purser-software`](https://github.com/JoinColony/purser/blob/master/modules/node_modules/@colony/purser-software): A `javascript` library to interact with a software Ethereum wallet, based on the [ethers.js](https://github.com/ethers-io/ethers.js/) library.
87-
- [`purser-trezor`](https://github.com/JoinColony/purser/blob/master/modules/node_modules/@colony/purser-trezor): A `javascript` library to interact with a [Trezor](https://trezor.io/) based Ethereum wallet.
60+
- [`@purser/core`](https://github.com/JoinColony/purser/blob/master/packages/@purser/core): A collection of `helpers`, `utils`, `validators` and `normalizers` to assist the individual purser modules.
61+
- [`@purser/metamask`](https://github.com/JoinColony/purser/blob/master/packages/@purser/metamask): A `javascript` library to interact with the a [Metamask](https://metamask.io/) based Ethereum wallet.
62+
- [`@purser/software`](https://github.com/JoinColony/purser/blob/master/packages/@purser/software): A `javascript` library to interact with a software Ethereum wallet, based on the [ethers.js](https://github.com/ethers-io/ethers.js/) library.
8863

8964
### The future
9065

‎packages/@purser/core/README.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
## [@colony/](https://www.npmjs.com/org/colony)purser-core
1+
## [@purser/core](https://www.npmjs.com/package/@purser/core)
22

33
A collection of `helpers`, `utils`, `validators` and `normalizers` to assist the individual [purser](https://github.com/JoinColony/purser) modules.
44

55
Unless you want something specific found in this module, it doesn't need to be manually required as each module already makes use of it internally.
66

77
### Installation
8-
```js
9-
yarn add @colony/purser-core
8+
```shell
9+
npm install @purser/core
1010
```
1111

12+
(Usually you won't install this package just on its own. It's meant to be an accompanying peer-dependency to the other @purser modules)
13+
1214
### Quick Usage
1315
```js
14-
import { bigNumber } from '@colony/purser-core/utils'
16+
import { bigNumber } from '@purser/core/utils'
1517

1618
const value = bigNumber('0.00000001').toWei();
1719

@@ -20,7 +22,7 @@ console.log(value); // { negative: 0, words: Array(4), length: 4, red: null }
2022

2123
### Documentation
2224

23-
You can find more in-depth description for this module's API in the [purser docs](https://docs.colony.io/purser/modules-@colonypurser-core/).
25+
You can find more in-depth description for this module's API in the [purser docs](https://joincolony.github.io/purser/modules/_purser_core.html).
2426

2527
### Contributing
2628

@@ -30,4 +32,4 @@ Please read our [Contributing Guidelines](https://github.com/JoinColony/purser/b
3032

3133
### License
3234

33-
The `purser-core` library along with the whole purser monorepo are [MIT licensed](https://github.com/JoinColony/purser/blob/master/LICENSE).
35+
The `@purser/core` library along with the whole purser monorepo are [MIT licensed](https://github.com/JoinColony/purser/blob/master/LICENSE).

‎packages/@purser/metamask/README.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
## [@colony/](https://www.npmjs.com/org/colony)purser-metamask
1+
## [@purser/metamask](https://www.npmjs.com/package/@purser/metamask)
22

3-
A `javascript` library to interact with the a [Metamask](https://metamask.io/) based Ethereum wallet.
4-
5-
It extracts all the complexity from setting up, maintaining and interacting with it, while providing you with a [predictable interface](https://docs.colony.io/purser/interface-common-wallet-interface/).
3+
A `javascript` library to interact with the a [Metamask](https://metamask.io/) based Ethereum wallet. It extracts all the complexity from setting up, maintaining and interacting with it, while providing you with a predictable interface.
64

75
### Installation
8-
```js
9-
yarn add @colony/purser-metamask
6+
```shell
7+
npm install ethers @purser/core @purser/metamask
108
```
119

1210
### Quick Usage
1311
```js
14-
import { open } from '@colony/purser-metamask'
12+
import { open } from '@purser/metamask'
1513

1614
const wallet = await open();
1715

@@ -20,7 +18,7 @@ console.log(wallet); // { address: '...', chainId: '...', publicKey: '...' }
2018

2119
### Documentation
2220

23-
You can find more in-depth description for this module's API in the [purser docs](https://docs.colony.io/purser/modules-@colonypurser-metamask/).
21+
You can find more in-depth description for this module's API in the [purser docs](https://joincolony.github.io/purser/modules/_purser_metamask.html).
2422

2523
### Contributing
2624

@@ -30,4 +28,4 @@ Please read our [Contributing Guidelines](https://github.com/JoinColony/purser/b
3028

3129
### License
3230

33-
The `purser-metamask` library along with the whole purser monorepo are [MIT licensed](https://github.com/JoinColony/purser/blob/master/LICENSE).
31+
The `@purser/metamask` library along with the whole purser monorepo are [MIT licensed](https://github.com/JoinColony/purser/blob/master/LICENSE).

‎packages/@purser/signer-ethers/README.md‎

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,40 @@
1-
# `@purser/signer-ethers`
1+
## [@purser/signer-ethers](https://www.npmjs.com/package/@purser/signer-ethers)
22

3-
> TODO: description
3+
This package allows you to use any purser wallet as an [ethers.js signer](https://docs.ethers.io/v4/api-wallet.html#signer).
44

5-
## Usage
5+
### Installation
66

7+
```shell
8+
npm install ethers @purser/core @purser/signer-ethers
79
```
8-
const signerEthers = require('@purser/signer-ethers');
910

10-
// TODO: DEMONSTRATE API
11+
### Quick Usage (using a MetaMask purser wallet)
12+
13+
```typescript
14+
import { getDefaultProvider } from "ethers";
15+
import { create } from "@purser/metamask";
16+
import { EthersSigner } from "@purser/signer-ethers";
17+
18+
const provider = getDefaultProvider("ropsten");
19+
20+
const initSigner = async () => {
21+
const wallet = await create();
22+
const signer = new EthersSigner({ purserWallet: wallet, provider });
23+
};
1124
```
25+
26+
You can then use the signer to [connect to Ethereum contracts with ethers](https://docs.ethers.io/v4/api-contract.html#connecting-to-a-contract).
27+
28+
### Documentation
29+
30+
You can find more in-depth description for this module's API in the [purser docs](https://joincolony.github.io/purser/modules/_purser_signer_ethers.html).
31+
32+
### Contributing
33+
34+
This package is part of the [purser monorepo](https://github.com/JoinColony/purser) package.
35+
36+
Please read our [Contributing Guidelines](https://github.com/JoinColony/purser/blob/master/.github/CONTRIBUTING.md) for how to get started.
37+
38+
### License
39+
40+
The `@purser/core` library along with the whole purser monorepo are [MIT licensed](https://github.com/JoinColony/purser/blob/master/LICENSE).

‎packages/@purser/software/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
## [@colony/](https://www.npmjs.com/org/colony)purser-software
1+
## [@purser/software](https://www.npmjs.com/package/@purser/software)
22

33
A `javascript` library to interact with a software Ethereum wallet, based on the [ethers.js](https://github.com/ethers-io/ethers.js/) library.
44

5-
It extracts all the complexity from setting up, maintaining and interacting with it, while providing you with a [predictable interface](https://docs.colony.io/purser/interface-common-wallet-interface/).
5+
It extracts all the complexity from setting up, maintaining and interacting with it, while providing you with a predictable interface.
66

77
### Installation
88
```js
9-
yarn add @colony/purser-software
9+
npm install ethers @purser/core @purser/software
1010
```
1111

1212
### Quick Usage
1313
```js
14-
import { open } from '@colony/purser-software'
14+
import { open } from '@purser/software'
1515

1616
const wallet = await open({ mnemonic: '...' });
1717

@@ -20,7 +20,7 @@ console.log(wallet); // { address: '...', privateKey: '...', publicKey: '...' }
2020

2121
### Documentation
2222

23-
You can find more in-depth description for this module's API in the [purser docs](https://docs.colony.io/purser/modules-@colonypurser-software/).
23+
You can find more in-depth description for this module's API in the [purser docs](https://joincolony.github.io/purser/modules/_purser_software.html).
2424

2525
### Contributing
2626

0 commit comments

Comments
 (0)