Skip to content

docs: make npm alpha easier to find and install - #53

Open
muhammadanas667 wants to merge 1 commit into
haseebahmed248:mainfrom
muhammadanas667:issue-30-npm-readme
Open

muhammadanas667 wants to merge 1 commit into
haseebahmed248:mainfrom
muhammadanas667:issue-30-npm-readme

Conversation

@muhammadanas667

@muhammadanas667 muhammadanas667 commented Sep 9, 2026 •

Copy link
Copy Markdown

Summary

Related issue

Closes #

Changes

Validation

  • npm run check
  • npm run check:generated
  • npm test
  • Additional validation is described below, or was not needed.

Additional validation:

Risk and compatibility

  • Security or permission effects:
  • Compatibility or breaking changes:

Checklist

  • This change is focused on one issue.
  • Behavioral changes include tests.
  • User-facing behavior and unsupported constructs are documented.
  • Generated files are current.
  • No credentials, private data, or unredacted model output are included.
  • Commits include the required DCO Signed-off-by line.

@haseebahmed248 haseebahmed248 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Anas, the badge and alpha warning look good. A few things before merging:

  • In both READMEs, add npx guardstep --version and npx guardstep --help after installation. Use npx for the installed-package examples too, since a local npm install does not put the CLI on the shell PATH. Keep ./gs for repository development.
  • Fill in the PR description with Closes #30, a short summary, and the checks you actually ran.
  • Add the required DCO Signed-off-by line to your commit.

I verified a fresh install and both CLI aliases report 0.1.0-alpha.1. Please test the updated instructions from a fresh directory and include the results. Thanks for picking this up!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants