Open
Conversation
Added a section about Sentinel usage in the README.
Added section on Client Config for sentinel mode, including example code.
|
Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset. In case there are security findings, they will be communicated to you as a comment inside the PR. Hope you’ll enjoy using Jit. Questions? Comments? Want to learn more? Get in touch with us. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This is addressing the seeming lack of documentation for sentinel. I spent a week looking at different libraries specifically because I could not find support for sentinel in the first readme, and a number of tickets that were asking for support.
this fixes #2454 #302 #592
Checklist
npm testpass with this change (including linting)?This is a documentation only change.
Note
Low Risk
Documentation-only updates; no runtime or API behavior changes, with only minor risk of confusion if links/examples are incorrect.
Overview
Adds a new Sentinel section to
README.mdthat points users to the dedicateddocs/sentinel.mdguide.Expands
docs/sentinel.mdwith a Client Config section showing how to pass standard client options (e.g.,password) vianodeClientOptionswhen using Sentinel.Written by Cursor Bugbot for commit b3a8fa0. This will update automatically on new commits. Configure here.