Skip to content

Update the "run locally" command in README #5

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.

Sign up for GitHub

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

Open
hkosova wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update the "run locally" command in README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ This is a **prototype** for digging into https://github.com/OAI/Overlay-Specific
It is published as an npm package `overlays-cli` which includes a simple binary cli.
To use, pipe in an Overlay definition and it'll output the result as YAML.

```sh
```

**Example Overlay**

```yaml
Expand Down Expand Up @@ -35,7 +32,7 @@ curl -sNL https://example.com | npx overlays-cli@latest
curl -sNL https://gist.githubusercontent.com/ponelat/daac5912ede1871629b6028bbe715d3a/raw/2871f9f27fb93d1c01567d198fb60cd1271e7dcf/overlay.yml | npx overlays-cli@latest

# If you clone the repo and want to run locally
cat overlays-sample.yml | node ./index.js
cat overlays-sample.yml | node ./bin.js
```

## Testing
Expand Down