docs(parse-duration): enhance readme.md

Alwatr · Jan 15, 2024 · 26faa6c · 26faa6c
1 parent fd32008
commit 26faa6c
Showing 1 changed file with 12 additions and 10 deletions.
diff --git a/packages/parse-duration/README.md b/packages/parse-duration/README.md
@@ -1,6 +1,6 @@
 # Parse-duration
 
-Parse duration string to target unit.
+A simple utility to parse a duration string into milliseconds.
 
 ## Installation
 
@@ -11,6 +11,8 @@ yarn add @alwatr/parse-duration
 ## Usage
 
 ```js
+import {parseDuration} from '@alwatr/parse-duration';
+
 parseDuration('10s'); // 10,000
 parseDuration('10m'); // 600,000
 parseDuration('10h'); // 36,000,000
@@ -23,12 +25,12 @@ parseDuration('10d', 'h'); // 240
 
 ### Abbreviation Table
 
-|  Abbreviation | Description |
-|     :---:     |   :---:     |
-|      `s`      |  Second     |
-|      `m`      |  Minute     |
-|      `h`      |  Hour       |
-|      `d`      |  Day        |
-|      `w`      |  Week       |
-|      `M`      |  Month      |
-|      `y`      |  Year       |
+| Abbreviation | Description |
+|--------------|-------------|
+|     `s`      |  Second     |
+|     `m`      |  Minute     |
+|     `h`      |  Hour       |
+|     `d`      |  Day        |
+|     `w`      |  Week       |
+|     `M`      |  Month      |
+|     `y`      |  Year       |