Skip to content

Commit

Permalink
Update function names
Browse files Browse the repository at this point in the history
  • Loading branch information
Shreyaschorge committed Nov 16, 2023
1 parent 3bdd045 commit da49ac4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
10 changes: 4 additions & 6 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Getting Started

Checkout the full github repo here:
https://github.com/neynarxyz/nodejs-sdk

Expand Down Expand Up @@ -63,9 +61,9 @@ touch .env
vim .env
```

Either use vim or your favourite editor to add NEYNAR_API_KEY in .env file as shown in .env.example file
Either use vim or your favourite editor to add `NEYNAR_API_KEY` in .env file as shown in .env.example file

You can get the NEYNAR_API_KEY from our official site: https://neynar.com/
You can get the `NEYNAR_API_KEY` from our official site: https://neynar.com/

```ini
# .env.example file
Expand All @@ -88,7 +86,7 @@ config();
export const NEYNAR_API_KEY = process.env.NEYNAR_API_KEY;
```

Congratulations..!! You have successfully done your installations and are ready to use environment variables in your project
You have successfully done your installations and are ready to use environment variables in your project

### Let use sdk to look up a user by their fid

Expand Down Expand Up @@ -147,7 +145,7 @@ cd ..
yarn start
```

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)
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)

```json
{
Expand Down
5 changes: 2 additions & 3 deletions scripts/getting-started.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import axios from "axios";
import { readFileSync } from "fs";

async function updateReadMeDocumentation(content: string): Promise<void> {
console.log("content", content);
async function updateGettingStartedWithSDK(content: string): Promise<void> {

const apiKey: string = process.env.README_API_KEY || "";
const slug: string = "getting-started-with-sdk";
Expand Down Expand Up @@ -30,4 +29,4 @@ async function updateReadMeDocumentation(content: string): Promise<void> {
const filePath: string = process.argv[2];
const contentBase64: string = readFileSync(filePath, "utf-8");
const content: string = Buffer.from(contentBase64, "base64").toString("utf-8");
updateReadMeDocumentation(content);
updateGettingStartedWithSDK(content);

0 comments on commit da49ac4

Please sign in to comment.