Skip to content

Commit

Permalink
📝 docs(env): up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
angelespejo committed Sep 28, 2024
1 parent 2de2c30 commit 8d987cc
Show file tree
Hide file tree
Showing 3 changed files with 535 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,25 @@
[![License](https://img.shields.io/github/license/pigeonposse/binarium?color=green&style=for-the-badge&logoColor=white)](/LICENSE)
[![Version](https://img.shields.io/npm/v/binarium?color=blue&style=for-the-badge&label=Version)](https://www.npmjs.com/package/binarium)

## Index

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [📖 Description](#-description)
- [🔑 Installation](#-installation)
- [📈 usage](#-usage)
- [Node example](#node-example)
- [CLI example](#cli-example)
- [Options](#options)
- [👨‍💻 Development](#-development)
- [☕ Donate](#-donate)
- [📜 License](#-license)
- [🐦 About us](#-about-us)
- [Collaborators](#collaborators)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## 📖 Description

Package your Node.js project into an executable that can be run even on devices without Node.js installed.
Expand Down Expand Up @@ -52,7 +71,7 @@ await build( {
binarium --input=src/server.js --name=app-name
```

### ⚙️ Options
### Options

All of these options are available with the `binarium` command by adding the suffix `--` and followed by an `=` and its value.

Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
"test:unit": "vitest run src --passWithNoTests",
"lint": "pnpm eslint src",
"update-version": "changeset && changeset version",
"prepush": "doctoc README.md",
"push": "git add . && cz && git push -f origin $@"
},
"devDependencies": {
Expand All @@ -82,6 +83,7 @@
"commitlint-config-gitmoji": "2.3.1",
"cz-customizable": "7.2.1",
"cz-emoji": "1.3.2-canary.2",
"doctoc": "^2.2.1",
"eslint": "8.57.0",
"eslint-plugin-align-assignments": "1.1.2",
"eslint-plugin-align-import": "1.0.0",
Expand Down
Loading

0 comments on commit 8d987cc

Please sign in to comment.