add documentation to README.md

lucalewin · Apr 1, 2023 · 188c479 · 188c479
1 parent f9436a6
commit 188c479
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,32 @@
 # Measurement
 
 Adds quantities and units to rust to allow unit safe computation
+
+## Define new quantity
+
+### Base Quantity
+
+```rust
+quantity! {
+    name: Time,
+    base_unit: Second,
+    units: {
+        Second:      1e+0,
+        Millisecond: 1e-3,
+    }
+}
+```
+
+### Derived Quantity
+
+```rust
+quantity! {
+    name: Velocity,
+    base_unit: MeterPerSecond,
+    units: {
+        MeterPerSecond: 1,
+        KilometerPerHour: 3.6,
+    },
+    derive: Length / Time,
+}
+```