Skip to content

Commit

Permalink
feat: update documentation for installation methods and add /dist to …
Browse files Browse the repository at this point in the history
….gitignore
  • Loading branch information
dwpeng committed Nov 3, 2024
1 parent 98d1397 commit 2a0b745
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/target
/*.csv
/*.txt
/dist
11 changes: 10 additions & 1 deletion docs/docs/manual.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,26 @@

## Installation

### Install by Cargo

```shell title=cargo
cargo install filterx
# or
cargo install --git git@github.com:dwpeng/filterx.git
```

### Install from Pip

```shell title=pip
pip install filterx
```

### Download from Github Release

```shell title=Github Prebuild Binary
https://github.com/dwpeng/filterx/releases
```


## Quick Start

```csv title=example.csv
Expand Down

0 comments on commit 2a0b745

Please sign in to comment.