Skip to content

Commit 8d1c601

Browse files
CJ42CJ42
authored
Merge pull request #937 from lukso-network/docs/readme
docs: add missing installation instructions in README
2 parents fbf7b3a + d7e3321 commit 8d1c601

File tree

19 files changed

+116
-3
lines changed

19 files changed

+116
-3
lines changed

‎README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,15 @@ This repo contains packages for the Solidity implementation of the LSP smart con
3939

4040
### npm
4141

42-
LSP smart contracts are available as a [npm package](https://www.npmjs.com/package/@lukso/lsp-smart-contracts).
42+
All the LSP smart contracts are available as **npm packages**. You can either install all the LSP smart contracts by installing [`@lukso/lsp-smart-contracts`](https://www.npmjs.com/package/@lukso/lsp-smart-contracts)
43+
or install the specific LSP that you might want from the list above. For instance, `@lukso/lsp7-contracts` to install only the LSP7 token contracts.
4344

4445
```bash
46+
# Install all the LSPs
4547
npm install @lukso/lsp-smart-contracts
48+
49+
# Install only the LSP7 tokens
50+
npm install @lukso/lsp7-contracts
4651
```
4752

4853
### cloning the repository

‎packages/lsp0-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP0 ERC725Account · [![npm version](https://img.shields.io/npm/v/@lukso/lsp0-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp0-contracts)
22

33
Package for the LSP0 ERC725Account standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp0-contracts
9+
```

‎packages/lsp1-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP1 Universal Receiver · [![npm version](https://img.shields.io/npm/v/@lukso/lsp1-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp1-contracts)
22

33
Package for the LSP1 Universal Receiver standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp1-contracts
9+
```

‎packages/lsp10-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP10 Received Vaults · [![npm version](https://img.shields.io/npm/v/@lukso/lsp10-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp10-contracts)
22

33
Package for the LSP10 Received Vaults standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp10-contracts
9+
```

‎packages/lsp12-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# · [![npm version](https://img.shields.io/npm/v/@lukso/lsp12-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp12-contracts)
22

33
Package for the LSP12 Issued Assets standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp12-contracts
9+
```

‎packages/lsp14-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP14 Ownable 2 Step · [![npm version](https://img.shields.io/npm/v/@lukso/lsp14-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp14-contracts)
22

33
Package for the LSP14 Ownable 2 Step standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp14-contracts
9+
```

‎packages/lsp16-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP16 Universal Factory · [![npm version](https://img.shields.io/npm/v/@lukso/lsp16-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp16-contracts)
22

33
Package for the [LSP16-UniversalFactory](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-16-UniversalFactory.md) standard, contains a contract that allows deploying contracts on multiple chains with the same address.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp16-contracts
9+
```

‎packages/lsp17-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,9 @@ Package for the LSP17 Extensions, that includes the following extensions:
44

55
- the `Extension4337` extension, which contains the `validateUserOp` function from the [`ERC4337` standard](https://eips.ethereum.org/EIPS/eip-4337).
66
- the `OnERC721ReceivedExtension` extension that contains the `onERC721Received` function from the [`ERC721` standard](https://eips.ethereum.org/EIPS/eip-721).
7+
8+
## Installation
9+
10+
```bash
11+
npm install @lukso/lsp17-contracts
12+
```

‎packages/lsp17contractextension-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP17 Contract Extension Package · [![npm version](https://img.shields.io/npm/v/@lukso/lsp17contractextension-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp17contractextension-contracts)
22

33
Package for the LSP17 Contract Extension
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp17contractextension-contracts
9+
```

‎packages/lsp1delegate-contracts/README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
# LSP1 Universal Receiver Delegate · [![npm version](https://img.shields.io/npm/v/@lukso/lsp1delegate-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp1delegate-contracts)
22

3-
Smart contract implementations of LSP1 Universal Receiver Delegates
3+
Smart contract implementations of [LSP1 Universal Receiver Delegate](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-1-UniversalReceiver.md#universalreceiver-delegation)
44
to register and manage:
55

66
- LSP5 Received Assets
77
- LSP10 Vaults
88

9-
Currently there are URDs for:
9+
Currently there are Universal Receiver Delegate contracts for:
1010

1111
- [Universal Profile](./contracts/LSP1UniversalReceiverDelegateUP.sol)
1212
- [Vault](./contracts/LSP1UniversalReceiverDelegateVault.sol)
13+
14+
## Installation
15+
16+
```bash
17+
npm install @lukso/lsp1delegate-contracts
18+
```

‎packages/lsp2-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP2 ERC725Y JSON Schema · [![npm version](https://img.shields.io/npm/v/@lukso/lsp2-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp2-contracts)
22

33
Package for the LSP2 ERC725Y JSON Schema standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp2-contracts
9+
```

‎packages/lsp23-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP23 Linked Contracts Factory · [![npm version](https://img.shields.io/npm/v/@lukso/lsp23-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp23-contracts)
22

33
Package for the LSP23 Linked Contracts Factory.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp23-contracts
9+
```

‎packages/lsp3-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP3 Profile Metadata · [![npm version](https://img.shields.io/npm/v/@lukso/lsp3-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp3-contracts)
22

33
Package for the LSP3 Profile Metadata standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp3-contracts
9+
```

‎packages/lsp4-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP4 Digital Asset Metadata · [![npm version](https://img.shields.io/npm/v/@lukso/lsp4-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp4-contracts)
22

33
Package for the LSP4 Digital Asset Metadata standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp4-contracts
9+
```

‎packages/lsp5-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP5 Received Assets · [![npm version](https://img.shields.io/npm/v/@lukso/lsp5-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp5-contracts)
22

33
Package for the LSP5 Received Assets standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp5-contracts
9+
```

‎packages/lsp6-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP6 Key Manager · [![npm version](https://img.shields.io/npm/v/@lukso/lsp6-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp6-contracts)
22

33
Package for the LSP6 Key Manager standard, to enable granting multiple permissions to controllers.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp6-contracts
9+
```

‎packages/lsp7-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP7 Digital Asset · [![npm version](https://img.shields.io/npm/v/@lukso/lsp7-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp7-contracts)
22

33
Package for the LSP7 Digital Asset standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp7-contracts
9+
```

‎packages/lsp8-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP8 Identifiable Digital Asset · [![npm version](https://img.shields.io/npm/v/@lukso/lsp8-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp8-contracts)
22

33
Package for the LSP8 Identifiable Digital Asset Standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp8-contracts
9+
```

‎packages/lsp9-contracts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# LSP9 Vault · [![npm version](https://img.shields.io/npm/v/@lukso/lsp9-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp9-contracts)
22

33
Package for the LSP9 Vault standard.
4+
5+
## Installation
6+
7+
```bash
8+
npm install @lukso/lsp9-contracts
9+
```

0 commit comments

Comments
 (0)