Skip to content

Commit 9c1708d

Browse files
authored
docs: Update README.md
1 parent 7168411 commit 9c1708d

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
# js-quic
1+
# js-exec
22

33
staging: [![pipeline status](https://gitlab.com/MatrixAI/open-source/js-exec/badges/staging/pipeline.svg)](https://gitlab.com/MatrixAI/open-source/js-exec/commits/staging)
44
master: [![pipeline status](https://gitlab.com/MatrixAI/open-source/js-exec/badges/master/pipeline.svg)](https://gitlab.com/MatrixAI/open-source/js-exec/commits/master)
55

6-
This is a simple native binding for running execpv
6+
This exposes `execvp` to Node.js. This allows running a child process that replaces the parent process image. This is not possible on Windows, if you run this on Windows, expect an exception!
77

88
## Installation
99

1010
```sh
11-
npm install --save @matrixai/quic
11+
npm install --save @matrixai/exec
1212
```
1313

1414
## Usage
1515

16-
See the example executables in `/src/bin`.
17-
1816
## Development
1917

2018
Run `nix develop`, and once you're inside, you can use:
@@ -55,21 +53,13 @@ x86_64-apple-darwin
5553

5654
The available target list is in `rustc --print target-list`.
5755

58-
## Benchmarks
59-
60-
```sh
61-
npm run bench
62-
```
63-
64-
View benchmarks here: https://github.com/MatrixAI/js-quic/blob/master/benches/results with https://raw.githack.com/
65-
6656
### Docs Generation
6757

6858
```sh
6959
npm run docs
7060
```
7161

72-
See the docs at: https://matrixai.github.io/js-quic/
62+
See the docs at: https://matrixai.github.io/js-exec/
7363

7464
### Publishing
7565

0 commit comments

Comments
 (0)