Added a command to run zippy via pkgx to the README.md

pull/8/head
Michael Essiet 2023-12-01 22:46:37 +01:00 zatwierdzone przez GitHub
rodzic ecbf832e97
commit be04405f8c
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 18 dodań i 7 usunięć

Wyświetl plik

@ -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)
### Installation
You can install zippy one of 2 ways:
#### Using python
```shell
python3 setup.py build && python3 setup.py sdist && pip3 install dist/*.tar.gz
```
#### 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.
First, build and install the tool:
```
$ python3 setup.py build && python3 setup.py sdist && pip3 install dist/*.tar.gz
```
Once you've [installed](#Installation) zippy it will add a new script (`zippy`) that you can use directly:
It will install 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 ...]