Skip to content

Commit

Permalink
Merge pull request #8 from michaelessiet/patch-1
Browse files Browse the repository at this point in the history
Added a command to run zippy via pkgx to the README.md
  • Loading branch information
ranok authored Dec 5, 2023
2 parents ecbf832 + be04405 commit 41d5d95
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,29 @@ Here are each of them compared with both the LZMA and zlib detector across the t

![ROC curve of detection tools](https://github.com/thinkst/zippy/blob/main/ai_detect_roc.png?raw=true)

### Usage
### Installation

ZipPy will read files passed as command-line arguments or will read from stdin to allow for piping of text to it.
You can install zippy one of 2 ways:

First, build and install the tool:
```
$ python3 setup.py build && python3 setup.py sdist && pip3 install dist/*.tar.gz
#### Using python

```shell
python3 setup.py build && python3 setup.py sdist && pip3 install dist/*.tar.gz
```

It will install a new script (`zippy`) that you can use directly:
#### Using pkgx

```shell
pkgx install zippy # or run it directly `pkgx zippy -h`
```

### Usage

ZipPy will read files passed as command-line arguments or will read from stdin to allow for piping of text to it.

Once you've [installed](#Installation) zippy it will add a new script (`zippy`) that you can use directly:

```shell
$ zippy -h
usage: zippy [-h] [-p P] [-e {zlib,lzma,brotli,ensemble}] [-s | sample_files ...]

Expand Down

0 comments on commit 41d5d95

Please sign in to comment.