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

Commit a5c6fd2

Browse files
committed
Further README fixes
1 parent 8be0aa6 commit a5c6fd2

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ To use the **software wallet** (based on the [ethers wallet](https://github.com/
2424

2525
#### Installation
2626

27-
```
27+
```shell
2828
npm install @purser/software
2929
```
3030

3131
#### Usage
3232

3333
Create a new wallet
3434

35-
```js
35+
```typescript
3636
import { create } from '@purser/software'
3737

3838
const wallet = await create();
@@ -42,7 +42,7 @@ console.log(wallet); // { address: '...', privateKey: '...', publicKey: '...' }
4242

4343
or open an existing one (based on the mnemnonic)
4444

45-
```js
45+
```typescript
4646
import { open } from '@purser/software'
4747

4848
const wallet = await open({ mnemonic: '...' });
@@ -60,6 +60,7 @@ Purser is a monorepo consisting of a collection of Ethereum wallet libraries:
6060
- [`@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.
6161
- [`@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.
6262
- [`@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.
63+
- [`@purser/signer-ethers`](https://github.com/JoinColony/purser/blob/master/packages/@purser/signer-ethers): An implementation of an [ethers](https://github.com/ethers-io/ethers.js/) signer to use with any of the purser compatible wallets.
6364

6465
### The future
6566

packages/@purser/core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ npm install @purser/core
1212
(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)
1313

1414
### Quick Usage
15-
```js
15+
```typescript
1616
import { bigNumber } from '@purser/core/utils'
1717

1818
const value = bigNumber('0.00000001').toWei();

packages/@purser/metamask/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ npm install ethers @purser/core @purser/metamask
88
```
99

1010
### Quick Usage
11-
```js
11+
```typescript
1212
import { open } from '@purser/metamask'
1313

1414
const wallet = await open();

packages/@purser/software/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ A `javascript` library to interact with a software Ethereum wallet, based on the
55
It extracts all the complexity from setting up, maintaining and interacting with it, while providing you with a predictable interface.
66

77
### Installation
8-
```js
8+
```shell
99
npm install ethers @purser/core @purser/software
1010
```
1111

1212
### Quick Usage
13-
```js
13+
```typescript
1414
import { open } from '@purser/software'
1515

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

0 commit comments

Comments
 (0)