From c0405ecf11cab8187b96b65e2b8875eb06021228 Mon Sep 17 00:00:00 2001 From: Chloe Cai <93294344+rollerchloe@users.noreply.github.com> Date: Wed, 27 Dec 2023 15:28:12 +0800 Subject: [PATCH] docs: add installation steps into readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 6697f0e..d1b446d 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,26 @@ - [**Semantic Release**](https://semantic-release.gitbook.io/semantic-release/) - A fully automated version management and package publishing tool - [**Debug**](https://github.com/visionmedia/debug) - A JS debugging utility that works in both node.js and browsers +## Installation + + +To install the React components for the decentralized renderer, download or `git clone` [this repository](https://github.com/Open-Attestation/decentralized-renderer-react-components): + +```sh +$ git clone https://github.com/Open-Attestation/decentralized-renderer-react-components.git my-components +$ cd my-components +$ rm -rf .git +$ npm install +``` + +Be sure to edit the following files according to your module information: + +- `package.json` (module name and version) +- `README.md` +- `LICENSE` +- Add your own template (in the `src` folder) and configure the template registry (in the `src/index.tsx` file). + + ## How it works To begin with, be sure to read the initial introduction and explanation about the [decentralized renderer](https://docs.opencerts.io/docs/migrations/v1_to_v2).