Skip to content

Commit

Permalink
Format readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Garulf committed Nov 17, 2023
1 parent 7eb776a commit 6d8ff4f
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
## Installation

Install via pip:

```
python -m pip install pyflowlauncher
```

## Usage

#### Basic plugin
### Basic plugin

A basic plugin using a function as the query method.
```

```py
from pyflowlauncher import Plugin, Result, send_results
from pyflowlauncher.result import, ResultResponse

Expand All @@ -30,9 +32,11 @@ def query(query: str) -> ResultResponse:
plugin.run()
```

#### Advanced plugin
### Advanced plugin

A more advanced usage using a `Method` class as the query method.
```

```py
from pyflowlauncher import Plugin, Result, Method
from pyflowlauncher.result import, ResultResponse

Expand All @@ -51,4 +55,4 @@ class Query(Method):

plugin.add_method(Query())
plugin.run()
```
```

0 comments on commit 6d8ff4f

Please sign in to comment.