Skip to content

Commit

Permalink
Add instructions && Links
Browse files Browse the repository at this point in the history
  • Loading branch information
DaevMithran committed Nov 16, 2024
1 parent 275c307 commit f54fe1c
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 8 deletions.
50 changes: 48 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<your-32-seed-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)
8 changes: 4 additions & 4 deletions demo/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit f54fe1c

Please sign in to comment.