Skip to content

Commit

Permalink
Merge pull request #937 from lukso-network/docs/readme
Browse files Browse the repository at this point in the history
docs: add missing installation instructions in README
  • Loading branch information
CJ42 authored Mar 28, 2024
2 parents fbf7b3a + d7e3321 commit 8d1c601
Show file tree
Hide file tree
Showing 19 changed files with 116 additions and 3 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions packages/lsp0-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp1-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp10-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp12-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp14-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp16-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp17-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp17contractextension-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
10 changes: 8 additions & 2 deletions packages/lsp1delegate-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp2-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp23-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp3-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp4-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp5-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp6-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp7-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp8-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions packages/lsp9-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 8d1c601

Please sign in to comment.