Skip to content

Commit 612a2e4

Browse files
authored
Update Readme
1 parent e0910d6 commit 612a2e4

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,51 @@
44

55
DenoX is a script runner and workspace wrapper for Deno
66

7-
In a similar fashion to `package.json` in NodeJS, you can specify a list of scripts and their respective permissions.
7+
Using DenoX, you can set up your deno workspace scripts permissions and options in declarative code.
88

9-
Instead of having to rely on `--allow-all` due to the tedious task of rewriting all your permissions in the shell, you can now write your permissions once in a `deno-workspace` file.
9+
In short, it allows you to to replace having to write this all the time:
1010

11-
## Installation
11+
```bash
12+
$ deno run --allow-read --allow-write --allow-net main.ts
13+
```
14+
15+
with this
16+
17+
```bash
18+
$ denox run start
19+
```
20+
21+
## Install/Upgrade
1222

1323
Prerequisites: [Deno](https://github.com/denoland/deno_install) (>=1.0.0)
1424

15-
`$ deno install -Af -n denox https://denopkg.com/BentoumiTech/denox/denox.ts`
25+
```bash
26+
$ deno install -Af -n denox https://denopkg.com/BentoumiTech/denox/denox.ts
27+
$ denox --help
28+
denox v0.2.0
1629

17-
You can now access `denox`
30+
Usage:
31+
$ denox <command> [options]
32+
33+
Commands:
34+
run <script> [...args] Run a script
35+
36+
For more info, run any command with the `--help` flag:
37+
$ denox run --help
38+
39+
Options:
40+
-h, --help Display this message
41+
-v, --version Display version number
42+
43+
Examples:
44+
denox run start
45+
```
1846

1947
## Getting Started
2048

2149
Create a file named `deno-workspace` at the root of your Deno project.
2250

23-
> Note: The `deno-workspace` file uses YAML
51+
> Note: `deno-workspace` format is YAML
2452
2553
### Scripts
2654

0 commit comments

Comments
 (0)