Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hongaar committed Apr 2, 2024
1 parent 6393d9e commit 7a0e9be
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ Simple and intuitive yet powerful and versatile framework for Node.js CLI progra
yarn|npm add bandersnatch
```

_We recommend using a_ Active LTS _or_ Maintenance LTS
_[Node.js version](https://nodejs.org/en/about/releases/)._ Current _versions
are tested, but not guaranteed to work._
> [!NOTE]
> We recommend using an _Active LTS_ or _Maintenance LTS_ [Node.js version](https://nodejs.org/en/about/releases/).
> _Current_ versions are tested, but not guaranteed to work.
### Simple example

Expand Down Expand Up @@ -316,10 +316,11 @@ $ node pizza.js "The Netherlands" --name Joram --confirmed
}
```

_Please note that even though `--confirmed` was specified on the command
line, it was still being prompted. This is a known issue. In this case, the
default value was the same as the input, in which case bandersnatch doesn't know
whether a value was explicitly passed in or inherited from the default value._
> [!WARNING]
> Please note that even though `--confirmed` was specified on the command
> line, it was still being prompted. This is a known issue. In this case, the
> default value was the same as the input, in which case bandersnatch doesn't know
> whether a value was explicitly passed in or inherited from the default value.
### TypeScript

Expand Down Expand Up @@ -360,9 +361,9 @@ type Args = {

---

_More examples in the
[examples](https://github.com/hongaar/bandersnatch/tree/main/examples)
directory._
> [!TIP]
> More examples in the [examples](https://github.com/hongaar/bandersnatch/tree/main/examples)
> directory.
## API

Expand Down Expand Up @@ -597,9 +598,9 @@ provides [everything you need](https://nodejs.org/api/console.html).
There are many options to bundle your application for distribution. We'll
discuss a common pattern.

_An example can be found in the
[examples/bundle](https://github.com/hongaar/bandersnatch/tree/main/examples/bundle)
directory._
> [!TIP]
> An example can be found in the [examples/bundle](https://github.com/hongaar/bandersnatch/tree/main/examples/bundle)
> directory.
Init a `package.json` if needed:

Expand Down Expand Up @@ -740,7 +741,8 @@ To create a binary (your app with Node.js bundled), add this script to
}
```

_Omit `-t host` to create binaries for all platforms._
> [!TIP]
> Omit `-t host` to create binaries for all platforms.
Run `yarn bundle` and then `./echo --help`. 💪

Expand Down

0 comments on commit 7a0e9be

Please sign in to comment.