Skip to content

Commit

Permalink
reorganise readme intro
Browse files Browse the repository at this point in the history
  • Loading branch information
Christopher Doris committed Jan 20, 2025
1 parent e87b129 commit 21ef313
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,28 +35,27 @@ julia> df >> @filter(age > 40) >> @select(num_children=children, age)
2 │ 4 79
```

Comparison with [Chain.jl](https://github.com/jkrumbiegel/Chain.jl) and
[Pipe.jl](https://github.com/oxinabox/Pipe.jl):
Quick comparison with similar packages:

| Feature | Chevy.jl | Chain.jl | Pipe.jl |
| Feature | Chevy.jl | [Chain.jl](https://github.com/jkrumbiegel/Chain.jl) | [Pipe.jl](https://github.com/oxinabox/Pipe.jl) |
| --- | --- | --- | --- |
| [Piping syntax](#getting-started) | ✔️ | ✔️ | ✔️ |
| [Side effects](#side-effects-with-) | ✔️ | ✔️ ||
| [Pipe backwards](#piping-backwards-with-) | ✔️ |||
| [Piping syntax](#getting-started) | ✔️ (`>>`) | ✔️ (`@chain`) | ✔️ (`|>`) |
| [Side effects](#side-effects-with-) | ✔️ (`>>>`) | ✔️ (`@aside`) ||
| [Pipe backwards](#piping-backwards-with-) | ✔️ (`<<`) |||
| [Recursive syntax](#recursive-usage) | ✔️ |||
| [REPL integration](#repl-integration) | ✔️ |||
| Line numbers on errors || ✔️ ||

## Installation
## Usage

### Installation

Click `]` to enter the Pkg REPL then do:

```
pkg> add Chevy
```

## Usage

### Getting started

Chevy exports a macro `@chevy` which transforms expressions like `x >> f(y, z)` into
Expand Down

0 comments on commit 21ef313

Please sign in to comment.