From da49ac43857a3f30676730bc56a5465fba2d1839 Mon Sep 17 00:00:00 2001 From: Shreyaschorge Date: Thu, 16 Nov 2023 22:33:56 +0530 Subject: [PATCH] Update function names --- docs/getting-started.md | 10 ++++------ scripts/getting-started.ts | 5 ++--- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 45c01112..a49e1d00 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,5 +1,3 @@ -## Getting Started - Checkout the full github repo here: https://github.com/neynarxyz/nodejs-sdk @@ -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 @@ -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 @@ -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 { diff --git a/scripts/getting-started.ts b/scripts/getting-started.ts index 5a7954e8..638ec161 100644 --- a/scripts/getting-started.ts +++ b/scripts/getting-started.ts @@ -1,8 +1,7 @@ import axios from "axios"; import { readFileSync } from "fs"; -async function updateReadMeDocumentation(content: string): Promise { - console.log("content", content); +async function updateGettingStartedWithSDK(content: string): Promise { const apiKey: string = process.env.README_API_KEY || ""; const slug: string = "getting-started-with-sdk"; @@ -30,4 +29,4 @@ async function updateReadMeDocumentation(content: string): Promise { 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);