From 6d8ff4f95fe1bd832bc7737520c1e9530994d21a Mon Sep 17 00:00:00 2001 From: Garulf <535299+Garulf@users.noreply.github.com> Date: Fri, 17 Nov 2023 03:35:02 -0500 Subject: [PATCH] Format readme --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index da5d98d..0a1c722 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -51,4 +55,4 @@ class Query(Method): plugin.add_method(Query()) plugin.run() -``` \ No newline at end of file +```