Skip to content

Commit

Permalink
docs(*): move nx attribution to bottom of README to improve readabili…
Browse files Browse the repository at this point in the history
…ty (#20)
  • Loading branch information
polymath-eric committed Oct 13, 2022
1 parent 667a27b commit dd29e9b
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 10 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Monorepo for Polymesh SDK compatible Signing Managers.

This project was generated using [Nx](https://nx.dev).

## Projects

| Project | Package | Version | Links |
Expand Down Expand Up @@ -35,3 +33,7 @@ You can also use nx commands directly with `yarn nx` (i.e. `yarn nx affected --t
## Contributing

Refer to the [Contribution Guidelines](CONTRIBUTING.md).

### Info

This project was generated using [Nx](https://nx.dev).
6 changes: 4 additions & 2 deletions packages/approval-signing-manager/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# approval-signing-manager

This library was generated with [Nx](https://nx.dev).

This signing manager was made with a specific API in which signatures for some transactions go through some kind of approval process. Some transaction may even require human approval which means the signing process may take a very long time in computer terms.

This signing manager makes a request for a signature, and continues to poll until the transaction is approved.
Expand Down Expand Up @@ -45,3 +43,7 @@ sdk.assets.createAsset(args, { mortality: { immortal: true } });
## Running unit tests

Run `nx test approval-signing-manager` to execute the unit tests via [Jest](https://jestjs.io).

### Info

This library was generated with [Nx](https://nx.dev).
6 changes: 4 additions & 2 deletions packages/browser-extension-signing-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Polymesh SDK (14+) compatible signing manager that manages accounts and signs via a polkadot compatible browser wallet extension.

This library was generated with [Nx](https://nx.dev).

## Usage

```typescript
Expand Down Expand Up @@ -31,3 +29,7 @@ signingManager.onNetworkChange(newNetwork => {
// act accordingly
});
```

### Info

This library was generated with [Nx](https://nx.dev).
6 changes: 4 additions & 2 deletions packages/hashicorp-vault-signing-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Polymesh SDK (v14+) compatible signing manager that interacts with a Hashicorp Vault for signing.

This library was generated with [Nx](https://nx.dev).

## Usage

```typescript
Expand All @@ -23,3 +21,7 @@ const sdk = await Polymesh.connect({
signingManager,
});
```

### Info

This library was generated with [Nx](https://nx.dev).
6 changes: 4 additions & 2 deletions packages/local-signing-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Polymesh SDK (v14+) compatible signing manager that stores private keys in memory.

This library was generated with [Nx](https://nx.dev).

## Usage

```typescript
Expand All @@ -24,3 +22,7 @@ const sdk = await Polymesh.connect({
signingManager,
});
```

### Info

This library was generated with [Nx](https://nx.dev).
2 changes: 2 additions & 0 deletions packages/types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

Base types for Signing Managers

### Info

This library was generated with [Nx](https://nx.dev).

0 comments on commit dd29e9b

Please sign in to comment.