chore: update README

2chevskii · Jan 23, 2024 · 7346c01 · 7346c01
1 parent 5490312
commit 7346c01
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,11 @@
 # Dvchevskii.Unit
 
 > Simple Unit type
+
+## What is it?
+
+This package provides a type which can only have a single instance.
+While it is basically a singleton, the correct usage for it is to
+represent the *absense* of a value (i.e. when you need to return **something**, which should never be used)
+
+Basically this is a `void` which can be used as a type argument