From 5d4ebc2bb40e2aac55891a0f44e36442981694bf Mon Sep 17 00:00:00 2001
From: Krithika <76915822+krithikasb@users.noreply.github.com>
Date: Wed, 8 Jun 2022 15:28:31 +0530
Subject: [PATCH] Clarify username and realm

I was confused and couldn't figure out what the username and realm were when I was trying to deploy without committing the zuliprc file, they're the same as email and site in zuliprc
---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 8d779c4..1aebb61 100644
--- a/README.md
+++ b/README.md
@@ -11,9 +11,9 @@ Javascript library to access the Zulip API
 ```js
 const zulipInit = require('zulip-js');
 const config = {
-  username: process.env.ZULIP_USERNAME,
-  apiKey: process.env.ZULIP_API_KEY,
-  realm: process.env.ZULIP_REALM,
+  username: process.env.ZULIP_USERNAME, // same as "email" in zuliprc
+  apiKey: process.env.ZULIP_API_KEY, // same as "key" in zuliprc
+  realm: process.env.ZULIP_REALM, // same as "site" in zuliprc
 };
 
 (async () => {
@@ -30,9 +30,9 @@ You will need to first retrieve the API key by calling `await zulipInit(config)`
 ```js
 const zulipInit = require('zulip-js');
 const config = {
-  username: process.env.ZULIP_USERNAME,
+  username: process.env.ZULIP_USERNAME, // same as "email" in zuliprc
   password: process.env.ZULIP_PASSWORD,
-  realm: process.env.ZULIP_REALM,
+  realm: process.env.ZULIP_REALM, // same as "site" in zuliprc
 };
 
 (async () => {