Skip to content

Commit 2a79073

Browse files
committed
docs: Add usage to README
1 parent 112b07b commit 2a79073

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,40 @@
22

33
Create self-contained binaries for all platforms supported by Node.js using [Node SEA][1].
44

5+
## Usage
6+
7+
### With `npx`
8+
9+
In the root of your Node.js project
10+
11+
```shell
12+
npx fossilize
13+
```
14+
15+
or just give it your entrypoint file
16+
17+
```shell
18+
npx fossilize main.js
19+
```
20+
21+
### As a dev dependency
22+
23+
It is also possible to use fossilize as a dev dependency. Add it to your project first:
24+
25+
```shell
26+
npm add --save-dev fossilize
27+
```
28+
29+
and then add a `compile` script to your project referencing fossilize:
30+
31+
```json
32+
{
33+
"scripts": {
34+
"compile": "fossilize -a some.html -n lts"
35+
}
36+
}
37+
```
38+
539
## What is it?
640

741
Fossilize is a tool to create Node SEAs (Single Executable Applications)

0 commit comments

Comments
 (0)