Docs: Document usage and API

gulpjs · Nov 29, 2018 · 621089a · 621089a
1 parent b7d2c54
commit 621089a
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,24 @@
 # fancy-log
 Log things, prefixed with a timestamp
+
+__This module was pulled out of gulp-util for use inside the CLI__
+
+## Usage
+
+```js
+var log = require('fancy-log');
+
+log('a message');
+// [16:27:02] a message
+```
+
+## API
+
+### log(msg...)
+
+Logs the message as if you called `console.log` but prefixes the output with the
+current time in HH:MM:ss format.
+
+## License
+
+MIT