-
-
Notifications
You must be signed in to change notification settings - Fork 34
docs(readme): create options, add more headings #132
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your PR :)
A little nit.
LGTM with the suggested change. ^^
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with @Fdawgs suggested changes. ^^
Co-authored-by: Frazer Smith <frazer.dev@outlook.com>
@Fdawgs okay your changes have been applied :) |
Co-authored-by: darkgl0w <31093081+darkgl0w@users.noreply.github.com>
As a developer, I want complete samples incl. minimum client configuration options, which would include the redis client password.
I had to manually open the ioredis documentation to check if it expected a
password
orsecret
configuration option. Probably the former. But including an example here saves first time users the trouble of looking it up - thanks 🙂 🙏Original
In the original, only the hostname was provided.
Btw - why was it
host
in the first example and thenurl
?Suggestion
Changes the 2nd example to include some common options, esp.
password
Checklist
npm run test
andnpm run benchmark
and the Code of conduct