Add meta

Author: Kikobeats

README.md

@@ -1,11 +1,5 @@
 # frowser
 
-<p align="center">
-  <br>
-  <img src="https://i.imgur.com/Mh13XWB.gif" alt="frowser">
-  <br>
-</p>
-
 ![Last version](https://img.shields.io/github/tag/Kikobeats/frowser.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/Kikobeats/frowser/master.svg?style=flat-square)](https://travis-ci.org/Kikobeats/frowser)
 [![Coverage Status](https://img.shields.io/coveralls/Kikobeats/frowser.svg?style=flat-square)](https://coveralls.io/github/Kikobeats/frowser)
@@ -14,9 +8,9 @@
 [![NPM Status](https://img.shields.io/npm/dm/frowser.svg?style=flat-square)](https://www.npmjs.org/package/frowser)
 [![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://paypal.me/Kikobeats)
 
-**NOTE:** more badges availables in [shields.io](https://shields.io/)
+> Simple & Functional Browser API.
 
-> Accessing to browser from the Upside Down
+This module is an API simplification over [Chrome Headless API](https://github.com/GoogleChrome/puppeteer) for do common actions, like take an screenshot.
 
 ## Install
 
@@ -35,23 +29,40 @@ frowser('do something')
 
 ## API
 
-### frowser(input, [options])
+All methods needs a  valid `url` as required first argument. The second argument will be `opts` for configure specific method settings.
+
+All methods expose an universal `promise`/`callback` interface: If you provide a function as last argument, then the output of the method will be following `callback` style. Otherwise, it returns an `promise`.
+
+### .html(url, [options], [cb])
+
+It returns the full HTML extracted from the URL.
+
+`opts` provided are passed to [page.goto](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagegotourl-options).
+
+### .pdf(url, [options], [cb])
+
+`opts` provided are passed to [page.goto](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagegotourl-options).
+
+Additionally you can setup the CSS media providing `opts.media` (by default it will be `'screen'`). This value will be passed to [page.emulateMedia](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pageemulatemediamediatype).
+
+### .screenshot(url, [options], [cb])
+
+It takes an screenshot of the URL.
+
+`opts` provided are passed to [page.screenshot](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagescreenshotoptions).
 
-#### input
+Additionally, you can setup the `device` providing `opts.device` and a valid [deviceDescriptor](https://github.com/GoogleChrome/puppeteer/blob/master/DeviceDescriptors.js).
 
-*Required*<br>
-Type: `string`
+It returns an [tmpStream](https://github.com/Kikobeats/create-temp-file2#create-temp-file2), with `path` where the temporal file live and `cleanup`/`cleanupSync` methods for clean the temporal file.
 
-Lorem ipsum.
+If you want to customize where tmpStream live, pass [opts.tmpOptions](https://github.com/Kikobeats/create-temp-file2#createtempfileoptions).
 
-#### options
+### .text(url, [options], [cb])
 
-##### foo
+It returns the text extracted from the URL.
 
-Type: `boolean`<br>
-Default: `false`
+`opts` provided are passed to [page.goto](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagegotourl-options).
 
-Lorem ipsum.
 ## License
 
 **frowser** © [Kiko Beats](https://kikobeats.com), Released under the [MIT](https://github.com/Kikobeats/frowser/blob/master/LICENSE.md) License.<br>

index.js

@@ -23,8 +23,8 @@ async function html (url, opts = {}) {
 }
 
 async function screenshot (url, opts = {}) {
-  const { type = 'png', device: deviceDescriptor } = opts
-  const tempFile = createTempFile({ ext: `.${type}` })
+  const { tmpOpts, type = 'png', device: deviceDescriptor } = opts
+  const tempFile = createTempFile(Object.assign({ ext: `.${type}` }, tmpOpts))
   const { path } = tempFile
 
   const browser = await puppeteer.launch()
@@ -44,13 +44,14 @@ async function screenshot (url, opts = {}) {
 
 async function pdf (url, opts = {}) {
   const tempFile = createTempFile({ ext: `.pdf` })
+  const { media = 'screen' } = opts
   const { path } = tempFile
 
   const browser = await puppeteer.launch()
   const page = await browser.newPage()
 
   await page.goto(url, { waitUntil: 'networkidle' })
-  await page.emulateMedia('screen')
+  await page.emulateMedia(media)
   await page.pdf(Object.assign({ path }, opts))
 
   return Promise.resolve(tempFile)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "frowser",
-  "description": "Accessing to browser from the Upside Down",
+  "description": "Simple & Functional Browser API.",
   "homepage": "https://documentup.com/Kikobeats/frowser",
   "version": "0.0.0",
   "main": "index.js",
@@ -16,7 +16,18 @@
   "bugs": {
     "url": "https://github.com/Kikobeats/frowser/issues"
   },
-  "keywords": [],
+  "keywords": [
+    "browser",
+    "browserless",
+    "chrome",
+    "chromeless",
+    "headless",
+    "html",
+    "pdf",
+    "puppeteer",
+    "screenshot",
+    "text"
+  ],
   "dependencies": {
     "create-temp-file2": "~2.0.0",
     "puppeteer": "~0.10.2"
@@ -36,6 +47,9 @@
   "engines": {
     "node": ">= 6"
   },
+  "files": [
+    "index.js"
+  ],
   "scripts": {
     "clean": "rm -rf node_modules",
     "coveralls": "nyc report --reporter=text-lcov | coveralls",
@@ -49,8 +63,8 @@
   "license": "MIT",
   "lint-staged": {
     "*.js": [
-      "prettier-standard",
-      "git add"
+      "git add",
+      "prettier-standard"
     ]
   },
   "standard": {