version 0.1.0

README.md

@@ -1 +1,58 @@
-# puppeteer-pretty-console
+<h1 align="center">puppeteer-pretty-console</h1>
+
+<p align="center">
+helper that setups console output for puppeteer
+</p>
+
+<p align="center">
+   <a href="#install">        🔧 <strong>Install</strong></a>
+ · <a href="#example">        🧩 <strong>Example</strong></a>
+ · <a href="#api">            📜 <strong>API docs</strong></a>
+ · <a href="https://github.com/stagas/puppeteer-pretty-console/releases"> 🔥 <strong>Releases</strong></a>
+ · <a href="#contribute">     💪🏼 <strong>Contribute</strong></a>
+ · <a href="https://github.com/stagas/puppeteer-pretty-console/issues">   🖐️ <strong>Help</strong></a>
+</p>
+
+***
+
+## Install
+
+```sh
+$ npm i puppeteer-pretty-console
+```
+
+## API
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+#### Table of Contents
+
+*   [puppeteerPrettyConsole](#puppeteerprettyconsole)
+    *   [Parameters](#parameters)
+
+### puppeteerPrettyConsole
+
+[src/index.ts:16-76](https://github.com/stagas/puppeteer-pretty-console/blob/278457b71514ec77623455172f900aca5b5d521c/src/index.ts#L16-L76 "Source code on GitHub")
+
+Setups console output for a puppeteer page.
+
+```ts
+const page = await browser.newPage()
+puppeteerPrettyConsole(page)
+```
+
+#### Parameters
+
+*   `page` **Page** A puppeteer page instance created by browser.newPage()
+
+## Contribute
+
+[Fork](https://github.com/stagas/puppeteer-pretty-console/fork) or
+[edit](https://github.dev/stagas/puppeteer-pretty-console) and submit a PR.
+
+All contributions are welcome!
+
+## License
+
+MIT © 2021
+[stagas](https://github.com/stagas)

package.json

@@ -3,7 +3,7 @@
   "author": "stagas",
   "short": "stagas/puppeteer-pretty-console",
   "description": "helper that setups console output for puppeteer",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "license": "MIT",
   "repository": {
     "type": "git",