diff --git a/README.md b/README.md index dad3746..850434b 100644 --- a/README.md +++ b/README.md @@ -1 +1,58 @@ -# puppeteer-pretty-console +

puppeteer-pretty-console

+ +

+helper that setups console output for puppeteer +

+ +

+ 🔧 Install + · 🧩 Example + · 📜 API docs + · 🔥 Releases + · 💪🏼 Contribute + · 🖐️ Help +

+ +*** + +## Install + +```sh +$ npm i puppeteer-pretty-console +``` + +## API + + + +#### 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) diff --git a/package.json b/package.json index 498fcbc..e813acb 100644 --- a/package.json +++ b/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",