Skip to content

docs: update setup instructions to use npm link instead of npx #64

Description

@nonz250

Summary

The README and documentation currently instruct users to run npx sabori-flow, but the package has not been published to npm yet. Running npx sabori-flow results in a 404 error.

Expected behavior

Setup instructions should use npm link for local development until the package is published to npm.

git clone https://github.com/nonz250/sabori-flow.git
cd sabori-flow
npm install
npm run build
npm link

sabori-flow init      # Create config.yml interactively
sabori-flow install   # Register with launchd

Scope

  • Update the primary setup instructions in README.md (and README.ja.md) to use npm link
  • Keep the npx sabori-flow instructions as a note for after npm publish

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions