Improve the documentation

Author: habedi

.github/workflows/tests.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       matrix:
         # Define the Rust versions to test against
-        rust-version: [ "1.83.0", "1.84.0", "stable", "beta" ]
+        rust-version: [ "1.86.0", "1.87.0", "stable", "beta" ]
 
     steps:
       - name: Checkout Repository

README.md

@@ -125,7 +125,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution
 The mascot is named "Graphina the Dinosaur".
 As the name implies, she's a dinosaur, however, she herself thinks she's a dragon.
 
-The logo was created using Gimp, ComfyUI, and a Flux Schnell v2 model.
+The logo was created using GIMP, ComfyUI, and a Flux Schnell v2 model.
 
 ### Licensing
 

docs/README.md

@@ -1,3 +1,3 @@
 # Graphina Documentation
 
-To be updated.
+To be added.

pygraphina/README.md

@@ -8,10 +8,14 @@
 
 PyGraphina Python library allows users to use [Graphina](https://github.com/habedi/graphina) in Python.
 
+> [!NOTE]
+> PyGraphina is far from finished.
+> It currently exposes only the core graph data structure from Rust.
+
 ### Installation
 
 ```bash
-pip install pygraphina
+pip install --pre pygraphina
 ```
 
 ### License

pyproject.toml

@@ -10,7 +10,8 @@ requires-python = ">=3.10,<4.0"
 dependencies = [
   "maturin[zig]>=1.8.3,<2.0.0",
   "huggingface-hub>=0.29.3,<0.30.0",
-  "networkx>=3.4.2,<4.0.0"
+  "networkx>=3.4.2,<4.0.0",
+  "pygraphina>=0.1.0",
 ]
 
 [project.optional-dependencies]