update README.md

magiclen · Nov 25, 2023 · 3781c4b · 3781c4b
1 parent bff851f
commit 3781c4b
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -66,6 +66,23 @@ assert_eq!("15.5 KB", format!("{byte:#}"));
 assert_eq!("15500 B", format!("{byte:#.0}"));
 ```
 
+#### Arithmetic
+
+There are `add`, `subtract`, `multiply`, and `divide` methods.
+
+```rust
+use byte_unit::Byte;
+
+let a = Byte::from_u64(15500);
+let b = Byte::from_u64(500);
+
+assert_eq!(16000, a.add(b).unwrap().as_u64());
+assert_eq!(15000, a.subtract(b).unwrap().as_u64());
+
+assert_eq!(31000, a.multiply(2).unwrap().as_u64());
+assert_eq!(3100, a.divide(5).unwrap().as_u64());
+```
+
 #### Find out an appropriate Unit
 
 The `get_exact_unit` and `get_recoverable_unit` methods is useful if you want to find out a unit that is appropriate for a `Byte` instance.

diff --git a/src/lib.rs b/src/lib.rs
@@ -64,6 +64,23 @@ assert_eq!("15.5 KB", format!("{byte:#}"));
 assert_eq!("15500 B", format!("{byte:#.0}"));
 ```
 
+#### Arithmetic
+
+There are `add`, `subtract`, `multiply`, and `divide` methods.
+
+```rust
+use byte_unit::Byte;
+
+let a = Byte::from_u64(15500);
+let b = Byte::from_u64(500);
+
+assert_eq!(16000, a.add(b).unwrap().as_u64());
+assert_eq!(15000, a.subtract(b).unwrap().as_u64());
+
+assert_eq!(31000, a.multiply(2).unwrap().as_u64());
+assert_eq!(3100, a.divide(5).unwrap().as_u64());
+```
+
 #### Find out an appropriate Unit
 
 The `get_exact_unit` and `get_recoverable_unit` methods is useful if you want to find out a unit that is appropriate for a `Byte` instance.