From d4fd4d8ea04e5430e86c193db8db4bc0379799d2 Mon Sep 17 00:00:00 2001
From: Liam Woodleigh <liam.woodleigh@gmail.com>
Date: Wed, 4 Oct 2023 22:27:27 +0200
Subject: [PATCH] Update docs

---
 README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5ef0815..f6f83d4 100644
--- a/README.md
+++ b/README.md
@@ -28,11 +28,13 @@ impl NewId for UserId {
             id: inner_id.into(),
         })
     }
+
+    fn get_inner_string(&self) -> String {
+        self.0.id.to_string()
+    }
 }
 ```
 
-> NOTE: For most use cases, most of the above code is boilerplate that could be eliminated with a procerdural macro, where the only thing specified is the table name. PRs welcome!
-
 Now you can instantiate the `UserId` type using `new`, and use it in your struct with SurrealDB like so:
 
 ```rust
@@ -60,6 +62,14 @@ let retrieved_user: User = create_result.unwrap().remove(0);
 assert_eq!(user_to_be_created, retrieved_user)
 ```
 
+You also get the following methods on your custom ID type for free:
+
+```rust
+typesafe_custom_id.table() // returns "users"
+typesafe_custom_id.id_with_brackets() // returns "⟨fa77edc3-56ed-4208-9e0b-c0b1c32e2d34⟩"
+typesafe_custom_id.id_without_brackets() // returns "fa77edc3-56ed-4208-9e0b-c0b1c32e2d34"
+```
+
 ## License
 
 Licensed under either of