Merge pull request #4 from RougeWare/feature/Clamps

Author: KyNorthstar

README.md

@@ -31,3 +31,25 @@ print(1_000_000.equals(1_000_100, tolerance: 1_000))
 ```
 
 Feel free to check out the tests for more examples!
+
+
+
+# Clamps #
+
+This includes a few functions which make it easy to clamp a value between two others. Like Swift's `min` and `max`, these work for any `Comparable` type.
+
+Whichever you use simply depends on your preference or needs; they all act identically:
+
+```swift
+print(clamp(min: 2, value:  0, max: 7)) // Prints 2
+print(clamp(min: 2, value:  5, max: 7)) // Prints 5
+print(clamp(min: 2, value: 99, max: 7)) // Prints 7
+
+print( 0.clamping(min: 2, max: 7)) // Prints 2
+print( 5.clamping(min: 2, max: 7)) // Prints 5
+print(99.clamping(min: 2, max: 7)) // Prints 7
+
+print( 0.clamping(within: 2...7)) // Prints 2
+print( 5.clamping(within: 2...7)) // Prints 5
+print(99.clamping(within: 2...7)) // Prints 7
+```