From ca39736bc93f6784555af04147011aab23ccce80 Mon Sep 17 00:00:00 2001
From: Maksim Shushkevich <meshushkevich@edu.hse.ru>
Date: Wed, 16 Oct 2024 17:53:50 +0300
Subject: [PATCH] Preparations for pre-release 0.0.2

---
 README.md      | 23 ++++++++++++++++++++++-
 pyproject.toml |  2 +-
 2 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index ee28528..57189cb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
 # Nodeflow
-This is a package that helps you combine python scrips using a node system
+----------
+Nodeflow if a framework to make pipelines from nodes. You can implement any logic you want by using Variable, 
+Function and Adapter nodes. Nodeflow support implicit converter for Variables with priority on non-lossy adapters
+converting pipeline 
+
+Installing
+----------
+Install NodeFlow from PyPI via ``pip install nodeflow``
+
+Usage
+----------
+To write your own things just implement all required methods in corresponding abstract classes.
+Example for Variable:
+```python
+from nodeflow.node.abstract import Variable
+
+
+class Bool(Variable):
+    def __init__(self, value: bool):
+        assert isinstance(value, bool)
+        super().__init__(value)
+```
diff --git a/pyproject.toml b/pyproject.toml
index bd2fe46..a3297ee 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nodeflow"
-version = "0.0.1"
+version = "0.0.2"
 description = ""
 authors = ["Maksim Shushkevich <m.e.shushkevich@yandex.com>"]
 license = "MIT"