From b927702ee2436fac69bb3110d62737fade077b78 Mon Sep 17 00:00:00 2001
From: Markus Scully <markus@mascully.com>
Date: Mon, 11 Aug 2025 13:23:16 +0300
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20README.md,=20varo:=20Fix=20docum?=
 =?UTF-8?q?entation=20errors=20and=20add=20new=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Corrected `Data::<ty()` to `Data::ty()` and added quotes around the example string in main README.
- Changed "derivation" to "derive macro" in the main README explanation.
- Updated all Nix run commands to use full `git+https` URLs with `.git` extension.
- Created a new README for the `varo` crate describing its planned purpose.
---
 README.md             | 8 ++++----
 crates/varo/README.md | 5 +++++
 2 files changed, 9 insertions(+), 4 deletions(-)
 create mode 100644 crates/varo/README.md

diff --git a/README.md b/README.md
index c5c0a26..24e878c 100644
--- a/README.md
+++ b/README.md
@@ -25,9 +25,9 @@ struct Data {
 }
 ```
 
-This generates a method `Vanth::ty()` which returns a `vanth::Ty`. This should represent the type's fully qualified name - its module path followed by the type itself and any generics it has. E.g. `Data::<ty().to_string()` could return `my::crate::module::Data`.
+This generates a method `Vanth::ty()` which returns a `vanth::Ty`. This should represent the type's fully qualified name - its module path followed by the type itself and any generics it has. E.g. `Data::ty().to_string()` could return `"my::crate::module::Data"`.
 
-The derivation only works for basic types right now and is not implemented for `std` types. Moving or renaming types or modules will change the type name, necessitating a database migration. This is not supported yet.
+The derive macro only works for basic types right now and is not implemented for `std` types. Moving or renaming types or modules will change the type name, necessitating a database migration. This is not supported yet.
 
 This should be used with caution. There are good reasons why `std::any::TypeId` is opaque.
 
@@ -47,9 +47,9 @@ let my_data: Data = store.get_from_hash(hash).unwrap();
 
 ## CLI usage
 
-You can run the Vanth CLI with Nix using `nix run https://git.mascully.com/mascully/vanth`.
+You can run the Vanth CLI with Nix using `nix run git+https://git.mascully.com/mascully/vanth.git`.
 
-Use `--` to pass arguments, e.g. `nix run https://git.mascully.com/mascully/vanth -- --help`.
+Use `--` to pass arguments, e.g. `nix run git+https://git.mascully.com/mascully/vanth.git -- --help`.
 
 ### Syntax
 
diff --git a/crates/varo/README.md b/crates/varo/README.md
new file mode 100644
index 0000000..8f2c40b
--- /dev/null
+++ b/crates/varo/README.md
@@ -0,0 +1,5 @@
+# Varo
+
+Varo is planned to be a testing framework for Vanth.
+
+It is not useable yet.