From 0f95928f20ac458aa8555f2eb94c85b921bf7bd5 Mon Sep 17 00:00:00 2001 From: Hugo Masclet Date: Wed, 29 Nov 2023 12:19:00 +0100 Subject: [PATCH] docs: update README and docs (#360) --- README.md | 26 +++++++++++++++----------- docs/getting-started.md | 1 - 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 433ac76c..c2e46c10 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ -# erc725.js · [![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](./LICENSE) [![npm version](https://img.shields.io/npm/v/@erc725/erc725.js.svg?style=flat)](https://www.npmjs.com/package/@erc725/erc725.js) -

-

@erc725/erc725.js

-

Allows for interfacing with ERC725Y compliant contracts on an EVM blockchain.

+

@erc725/erc725.js

+

Allows for interacting with ERC725Y compliant contracts on an EVM blockchain.

+ + NPM version + Tests Passing +

+ +

@@ -19,13 +23,10 @@ GitHub pull requests

-

For more information see Documentation.

+

For more information see the Documentation.

## Installation -| :warning: | _This package is currently in early stages of development,
use for testing or experimentation purposes only._ | -| :-------: | :----------------------------------------------------------------------------------------------------------------- | - ```shell script npm install @erc725/erc725.js ``` @@ -38,11 +39,12 @@ import ERC725 from '@erc725/erc725.js'; If you install it on the backend side, you may need to also install [`isomorphic-fetch`](https://www.npmjs.com/package/isomorphic-fetch). -## Usage +## Instantiation + +You need to initialise it with a [schema](https://docs.lukso.tech/tools/erc725js/schemas), a contract address and an RPC URL. ```js import { ERC725 } from '@erc725/erc725.js'; -import Web3 from 'web3'; // Part of LSP3-Profile Schema // https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-3-Profile-Metadata.md @@ -166,10 +168,12 @@ await myErc725.fetchData(); */ ``` +For more information 👉 [check the docs](https://docs.lukso.tech/tools/erc725js/classes/ERC725). + ## Contributing Please check [CONTRIBUTING](./CONTRIBUTING.md). -### License +## License erc725.js is [Apache 2.0 licensed](./LICENSE). diff --git a/docs/getting-started.md b/docs/getting-started.md index 68abf9ff..1cb54779 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -29,7 +29,6 @@ If you install it on the backend side, you may need to also install [`isomorphic ```js import { ERC725 } from '@erc725/erc725.js'; -import Web3 from 'web3'; // Part of LSP3-UniversalProfile Schema // https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-3-UniversalProfile.md