From 1c730489ee86f9806b979bda00079df3bd564e1e Mon Sep 17 00:00:00 2001
From: Illya Laifu <illyalaifu@gmail.com>
Date: Thu, 28 Nov 2024 16:11:26 +0200
Subject: [PATCH] feat: disable package mode for the poetry and update readme

---
 README.md      | 30 +++++++++++++++++++++++++++---
 pyproject.toml |  3 ++-
 2 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index cb76fb1..a38bf67 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,32 @@
 
 This submodule contains bindings to the Taskchampion
 
-# TODO
+## Development
+
+This project is built using [maturin](https://github.com/PyO3/maturin).
+
+To install:
+
+```shell
+pipx install maturin
+```
+
+To build wheels:
+```shell
+maturin build
+```
+This stores wheels in the `target/wheels` folder by default.
+
+### Testing
+
+Extra testing dependencies are installed via `poetry`:
+```shell
+poetry install
+```
+
+
+
+## TODO
 
 - There is no good way to describe functions that accept interface (e.g. `Replica::new` accepts any of the storage implementations, but Python bindings lack such mechanisms), currently, `Replica::new` just constructs the SqliteStorage from the params passed into the constructor.
-- It is possible to convert `WorkingSet` into a python iterator (you can iterate over it via `for item in <blah>:` or `next(<blah>)`), but that needs a way to store the current state.
-- Possible integration with Github Workflows for deployment.
+- Possible integration with Github Workflows for deployment to PyPI
diff --git a/pyproject.toml b/pyproject.toml
index 0cc0b8d..68300ad 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -20,10 +20,11 @@ name = "taskchampion-py"
 version = "0.1.0"
 authors = ["illyalaifu <illyalaifu@gmail.com>"]
 description = ""
+package-mode = false
 
 [tool.poetry.dependencies]
 python = ">=3.8"
-maturin = {extras = ["patchelf"], version = "^1.5.1"}
+maturin = { extras = ["patchelf"], version = "^1.5.1" }
 
 [tool.poetry.group.test.dependencies]
 pytest = "^8.2.0"