docs: add uniform install section to readmes #4633
Open
Conversation
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
|
Merging to
|
qw-in
approved these changes
Jul 16, 2025
arcjet-deno/README.md
Outdated
| Install with XXX: | ||
|
|
||
| ```sh | ||
| TODO: what should we recommend? |
There was a problem hiding this comment.
I would expect this to be
deno install npm:@arcjet/deno
Unless we are publishing to jsr? I have not had a chance to try deno yet, I can test it if you'd like
There was a problem hiding this comment.
I did that, that’s probably good!
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.
This PR adds a uniform install section to everything.
One open question is what to recommend with Deno.
Some changes with reasons:
Installinstead ofInstallation— I just don’t see the need for the extra charactersshinstead ofshell— same, people often use shorter flags here rather than entire language names (they are interchangeable on GH and in all tools that I am aware of)-Sflag, which is the current behavior, and for people that choose to install with particular flags, this allows that.npmand specifically alsoNode.jsand hereRelated-to: GH-4338.