diff --git a/README.md b/README.md index f42ebb9..ae7a2f9 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,6 @@ import Mass from 'mass.js'; let value = Mass.parse('5 lbs 8 oz'); // Parse string for mass value += 5.5; // Add 5.5 pounds Mass.format(value); // Format total: "11 lb" -Mass.format(value, { written: true }); // Written format: "eleven pounds" ``` ## Units @@ -55,19 +54,12 @@ Format number as string. - **unit:** `(number|string)` Base unit value or string for lookup (default: 1). -- **written:** `(Object|string|boolean)` [n2words](https://github.com/forzagreen/n2words) options or language identifier (as string), otherwise boolean (default: false). - Returns `value` formatted as `string`, or if unit lookup fails, `undefined`. **Examples:** ```javascript Mass.format(11); - -Mass.format(176, { - unit: 'oz', - written: true -}); ``` ------------