diff --git a/README.md b/README.md index 1f25da4..93be6f6 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,52 @@ const getAttestationRes = await client.getAttestation("0x3", { }) // specify gated to decrypt attestation ``` -### Developer Feedback +### Instructions -A detailed feedback can be found [here](https://github.com/EthSign/ethglobal-bangkok-2024-tracker/issues/4) +Follow the steps below to clone the repository, set up the environment, and run the demo: + +#### Clone the Repository + +1. Clone the repository to your local machine using the following command: + + ```bash + git clone https://github.com/DaevMithran/SignxLit.git + ``` + +2. Navigate to the Demo Directory + + ```bash + cd demo + ``` + +3. Install Dependencies + + ```bash + npm i --save + ``` + +4. Add a Private Key + +- Create a .env file in the demo directory. +- Add a 32-seed private key in the .env file as follows: + + ```bash + PRIVATE_KEY= + ``` + +5. Build the Project + + ```bash + npm run build + ``` + +6. Start the Demo + + ```bash + npm start + ``` + +### Links + +- Developer Feedback: A detailed feedback can be found [here](https://github.com/EthSign/ethglobal-bangkok-2024-tracker/issues/4) +- [Demo Video](https://www.youtube.com/watch?v=G3WXEwannUU) diff --git a/demo/package-lock.json b/demo/package-lock.json index 192d158..72bfc59 100644 --- a/demo/package-lock.json +++ b/demo/package-lock.json @@ -9,7 +9,7 @@ "version": "1.0.0", "license": "ISC", "dependencies": { - "@daevm/ethsign-sp-sdk": "^0.8.4", + "@daevm/ethsign-sp-sdk": "^0.8.5", "chalk": "^5.3.0", "figlet": "^1.8.0", "inquirer": "^12.1.0", @@ -92,9 +92,9 @@ } }, "node_modules/@daevm/ethsign-sp-sdk": { - "version": "0.8.4", - "resolved": "https://registry.npmjs.org/@daevm/ethsign-sp-sdk/-/ethsign-sp-sdk-0.8.4.tgz", - "integrity": "sha512-ru5R1A9+DG24R7a2M1xrufX4tv8jt8veBVYOM3Rx0JU2dc/bqljhb6sQooe8zFo40B7Bc6n0b+ANkA6sTxfeNw==", + "version": "0.8.5", + "resolved": "https://registry.npmjs.org/@daevm/ethsign-sp-sdk/-/ethsign-sp-sdk-0.8.5.tgz", + "integrity": "sha512-kK4rNYLzfHDcn1sA8CDHInUse8n57hbFh+9HMSKpseQBz12qWJGrfCcvR5eioA3Qwwzg3LVdQjYAEJdwBQTNNg==", "dependencies": { "@lit-protocol/auth-helpers": "^6.11.1", "@lit-protocol/constants": "^6.11.1", diff --git a/demo/package.json b/demo/package.json index f10998e..c5db4e0 100644 --- a/demo/package.json +++ b/demo/package.json @@ -13,7 +13,7 @@ "author": "", "license": "ISC", "dependencies": { - "@daevm/ethsign-sp-sdk": "^0.8.4", + "@daevm/ethsign-sp-sdk": "^0.8.5", "chalk": "^5.3.0", "figlet": "^1.8.0", "inquirer": "^12.1.0", diff --git a/package.json b/package.json index d23a3de..427f6e6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@daevm/ethsign-sp-sdk", - "version": "0.8.4", + "version": "0.8.5", "description": "", "source": "src/index.ts", "main": "build/esm/index.js",