Skip to content

Clarify username and realm #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify username and realm #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 () => {
Expand All @@ -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 () => {
Expand Down