Skip to content

Commit

Permalink
chore: fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jordan-Kowal committed Oct 25, 2024
1 parent afb7046 commit d70b868
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@

- [✨ Pipe Operator ✨](#-pipe-operator-)
- [⚡ Quick start](#-quick-start)
- [🧰 How to use](#-how-to-use)
- [🐍 Pythonic implementation](#-pythonic-implementation)
- [Available classes](#available-classes)
- [Limitations](#limitations)
Expand All @@ -26,7 +25,15 @@ This module provides 2 vastly different implementations, each with its own pros

## ⚡ Quick start

The 🐍 **pythonic** implementation, which is **entirely compatible with linters and type-checkers**,
As simple as `pip install pipe_operator`.
Then either import the 🐍 **pythonic** or the 🍹 **elixir** implementations

```python
from pipe_operator.elixir_flow import elixir_pipe, tap, then
from pipe_operator.python_flow import Pipe, PipeArgs, PipeEnd, PipeStart, Tap, Then
```

You can use the 🐍 **pythonic** implementation, which is **entirely compatible with linters and type-checkers**,
but a bit more verbose than the original pipe operator:

```python
Expand All @@ -48,7 +55,7 @@ result = (
)
```

And the 🍹 **elixir-like** implementation, whose syntax greatly resembles the original pipe operator,
Or the 🍹 **elixir-like** implementation, whose syntax greatly resembles the original pipe operator,
but has major issues with linters and type-checkers.

```python
Expand Down Expand Up @@ -77,16 +84,6 @@ def workflow(value):
workflow(3)
```

## 🧰 How to use

As simple as `pip install pipe_operator`.
Then either import the **pythonic** or the **elixir** implementations

```python
from pipe_operator.elixir_flow import elixir_pipe, tap, then
from pipe_operator.python_flow import Pipe, PipeArgs, PipeEnd, PipeStart, Tap, Then
```

## 🐍 Pythonic implementation

### Available classes
Expand Down

0 comments on commit d70b868

Please sign in to comment.