Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
Docs
  • Loading branch information
Shreyaschorge authored Nov 17, 2023
2 parents 29d2463 + 0abdaad commit 1c0e6f7
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ tsc --init
<!-- Following text is indented with non-breaking spaces. -->
&nbsp;&nbsp;&nbsp;&nbsp;

### Let's use sdk to look up a user by their FID
### Example: Let's use sdk to look up a user by their FID

Create index.ts file at root level

```bash
touch index.ts
Expand Down Expand Up @@ -68,20 +70,10 @@ const client = new NeynarAPIClient("<YOUR_API_KEY_HERE>"); // Replace with your
})();
```

#### Update script section in package.json

```json
{
"scripts": {
"start": "npx ts-node index.ts"
}
}
```

Run the script
Run the project

```bash
yarn start
npx ts-node index.ts
```

You should see a response like this. (You might not get beautified/ formated response since we `JSON.stringify` the response in order to log everything)
Expand Down Expand Up @@ -116,4 +108,4 @@ You should see a response like this. (You might not get beautified/ formated res
}
```

### Congratulation..!! 🎉 You successfully setup @neynar/nodejs-sdk and used it to look up a user by their FID.
### Congratulation..!! 🎉 You successfully setup @neynar/nodejs-sdk and used it to look up a user by their FID.

0 comments on commit 1c0e6f7

Please sign in to comment.