From d7e33211eb9680711df8066a50684f6ae9b3d876 Mon Sep 17 00:00:00 2001 From: CJ42 Date: Wed, 27 Mar 2024 21:43:14 +0000 Subject: [PATCH] docs: add missing installation instructions in README --- README.md | 7 ++++++- packages/lsp0-contracts/README.md | 6 ++++++ packages/lsp1-contracts/README.md | 6 ++++++ packages/lsp10-contracts/README.md | 6 ++++++ packages/lsp12-contracts/README.md | 6 ++++++ packages/lsp14-contracts/README.md | 6 ++++++ packages/lsp16-contracts/README.md | 6 ++++++ packages/lsp17-contracts/README.md | 6 ++++++ packages/lsp17contractextension-contracts/README.md | 6 ++++++ packages/lsp1delegate-contracts/README.md | 10 ++++++++-- packages/lsp2-contracts/README.md | 6 ++++++ packages/lsp23-contracts/README.md | 6 ++++++ packages/lsp3-contracts/README.md | 6 ++++++ packages/lsp4-contracts/README.md | 6 ++++++ packages/lsp5-contracts/README.md | 6 ++++++ packages/lsp6-contracts/README.md | 6 ++++++ packages/lsp7-contracts/README.md | 6 ++++++ packages/lsp8-contracts/README.md | 6 ++++++ packages/lsp9-contracts/README.md | 6 ++++++ 19 files changed, 116 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aa4d42795..026e3c997 100644 --- a/README.md +++ b/README.md @@ -39,10 +39,15 @@ This repo contains packages for the Solidity implementation of the LSP smart con ### npm -LSP smart contracts are available as a [npm package](https://www.npmjs.com/package/@lukso/lsp-smart-contracts). +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) +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. ```bash +# Install all the LSPs npm install @lukso/lsp-smart-contracts + +# Install only the LSP7 tokens +npm install @lukso/lsp7-contracts ``` ### cloning the repository diff --git a/packages/lsp0-contracts/README.md b/packages/lsp0-contracts/README.md index 440de54b1..4ecc1cd76 100644 --- a/packages/lsp0-contracts/README.md +++ b/packages/lsp0-contracts/README.md @@ -1,3 +1,9 @@ # LSP0 ERC725Account · [![npm version](https://img.shields.io/npm/v/@lukso/lsp0-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp0-contracts) Package for the LSP0 ERC725Account standard. + +## Installation + +```bash +npm install @lukso/lsp0-contracts +``` diff --git a/packages/lsp1-contracts/README.md b/packages/lsp1-contracts/README.md index 844e82f92..c3fc7eeb5 100755 --- a/packages/lsp1-contracts/README.md +++ b/packages/lsp1-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP1 Universal Receiver standard. + +## Installation + +```bash +npm install @lukso/lsp1-contracts +``` diff --git a/packages/lsp10-contracts/README.md b/packages/lsp10-contracts/README.md index e3d535d0c..a49fe242c 100755 --- a/packages/lsp10-contracts/README.md +++ b/packages/lsp10-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP10 Received Vaults standard. + +## Installation + +```bash +npm install @lukso/lsp10-contracts +``` diff --git a/packages/lsp12-contracts/README.md b/packages/lsp12-contracts/README.md index 71c57f54e..0f6521c42 100644 --- a/packages/lsp12-contracts/README.md +++ b/packages/lsp12-contracts/README.md @@ -1,3 +1,9 @@ # · [![npm version](https://img.shields.io/npm/v/@lukso/lsp12-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp12-contracts) Package for the LSP12 Issued Assets standard. + +## Installation + +```bash +npm install @lukso/lsp12-contracts +``` diff --git a/packages/lsp14-contracts/README.md b/packages/lsp14-contracts/README.md index 6790c77d1..04abd0501 100755 --- a/packages/lsp14-contracts/README.md +++ b/packages/lsp14-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP14 Ownable 2 Step standard. + +## Installation + +```bash +npm install @lukso/lsp14-contracts +``` diff --git a/packages/lsp16-contracts/README.md b/packages/lsp16-contracts/README.md index 291cacccb..7548025c1 100644 --- a/packages/lsp16-contracts/README.md +++ b/packages/lsp16-contracts/README.md @@ -1,3 +1,9 @@ # 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) 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. + +## Installation + +```bash +npm install @lukso/lsp16-contracts +``` diff --git a/packages/lsp17-contracts/README.md b/packages/lsp17-contracts/README.md index e32a04e8e..6f4d91b66 100644 --- a/packages/lsp17-contracts/README.md +++ b/packages/lsp17-contracts/README.md @@ -4,3 +4,9 @@ Package for the LSP17 Extensions, that includes the following extensions: - the `Extension4337` extension, which contains the `validateUserOp` function from the [`ERC4337` standard](https://eips.ethereum.org/EIPS/eip-4337). - the `OnERC721ReceivedExtension` extension that contains the `onERC721Received` function from the [`ERC721` standard](https://eips.ethereum.org/EIPS/eip-721). + +## Installation + +```bash +npm install @lukso/lsp17-contracts +``` diff --git a/packages/lsp17contractextension-contracts/README.md b/packages/lsp17contractextension-contracts/README.md index 32174d962..099165520 100644 --- a/packages/lsp17contractextension-contracts/README.md +++ b/packages/lsp17contractextension-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP17 Contract Extension + +## Installation + +```bash +npm install @lukso/lsp17contractextension-contracts +``` diff --git a/packages/lsp1delegate-contracts/README.md b/packages/lsp1delegate-contracts/README.md index 0b53ff37e..4f9e9827d 100644 --- a/packages/lsp1delegate-contracts/README.md +++ b/packages/lsp1delegate-contracts/README.md @@ -1,12 +1,18 @@ # 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) -Smart contract implementations of LSP1 Universal Receiver Delegates +Smart contract implementations of [LSP1 Universal Receiver Delegate](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-1-UniversalReceiver.md#universalreceiver-delegation) to register and manage: - LSP5 Received Assets - LSP10 Vaults -Currently there are URDs for: +Currently there are Universal Receiver Delegate contracts for: - [Universal Profile](./contracts/LSP1UniversalReceiverDelegateUP.sol) - [Vault](./contracts/LSP1UniversalReceiverDelegateVault.sol) + +## Installation + +```bash +npm install @lukso/lsp1delegate-contracts +``` diff --git a/packages/lsp2-contracts/README.md b/packages/lsp2-contracts/README.md index a398f1955..abacbd0fa 100755 --- a/packages/lsp2-contracts/README.md +++ b/packages/lsp2-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP2 ERC725Y JSON Schema standard. + +## Installation + +```bash +npm install @lukso/lsp2-contracts +``` diff --git a/packages/lsp23-contracts/README.md b/packages/lsp23-contracts/README.md index a2d5d1005..b9e53fea3 100644 --- a/packages/lsp23-contracts/README.md +++ b/packages/lsp23-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP23 Linked Contracts Factory. + +## Installation + +```bash +npm install @lukso/lsp23-contracts +``` diff --git a/packages/lsp3-contracts/README.md b/packages/lsp3-contracts/README.md index 67206545b..202a88434 100644 --- a/packages/lsp3-contracts/README.md +++ b/packages/lsp3-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP3 Profile Metadata standard. + +## Installation + +```bash +npm install @lukso/lsp3-contracts +``` diff --git a/packages/lsp4-contracts/README.md b/packages/lsp4-contracts/README.md index 1ad07fe4e..02c98cf73 100644 --- a/packages/lsp4-contracts/README.md +++ b/packages/lsp4-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP4 Digital Asset Metadata standard. + +## Installation + +```bash +npm install @lukso/lsp4-contracts +``` diff --git a/packages/lsp5-contracts/README.md b/packages/lsp5-contracts/README.md index 377aee038..71cc26ceb 100644 --- a/packages/lsp5-contracts/README.md +++ b/packages/lsp5-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP5 Received Assets standard. + +## Installation + +```bash +npm install @lukso/lsp5-contracts +``` diff --git a/packages/lsp6-contracts/README.md b/packages/lsp6-contracts/README.md index f0b0afca7..f27ef7e28 100644 --- a/packages/lsp6-contracts/README.md +++ b/packages/lsp6-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP6 Key Manager standard, to enable granting multiple permissions to controllers. + +## Installation + +```bash +npm install @lukso/lsp6-contracts +``` diff --git a/packages/lsp7-contracts/README.md b/packages/lsp7-contracts/README.md index 7d878e99a..8b4e22be8 100644 --- a/packages/lsp7-contracts/README.md +++ b/packages/lsp7-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP7 Digital Asset standard. + +## Installation + +```bash +npm install @lukso/lsp7-contracts +``` diff --git a/packages/lsp8-contracts/README.md b/packages/lsp8-contracts/README.md index 45de90454..5a6e67dd1 100644 --- a/packages/lsp8-contracts/README.md +++ b/packages/lsp8-contracts/README.md @@ -1,3 +1,9 @@ # 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) Package for the LSP8 Identifiable Digital Asset Standard. + +## Installation + +```bash +npm install @lukso/lsp8-contracts +``` diff --git a/packages/lsp9-contracts/README.md b/packages/lsp9-contracts/README.md index 8ad3ad43c..09bce1998 100644 --- a/packages/lsp9-contracts/README.md +++ b/packages/lsp9-contracts/README.md @@ -1,3 +1,9 @@ # LSP9 Vault · [![npm version](https://img.shields.io/npm/v/@lukso/lsp9-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/lsp9-contracts) Package for the LSP9 Vault standard. + +## Installation + +```bash +npm install @lukso/lsp9-contracts +```