Skip to content
This repository has been archived by the owner on Jul 24, 2019. It is now read-only.

Commit

Permalink
Merge pull request #453 from Medium/nick-prebuilt
Browse files Browse the repository at this point in the history
Change package name to phantomjs-prebuilt for #447
  • Loading branch information
nicks committed Jan 28, 2016
2 parents 8ed9c6f + dbf4a91 commit 304f64a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
phantomjs
=========
phantomjs-prebuilt
==================

An NPM installer for [PhantomJS](http://phantomjs.org/), headless webkit with JS API.

Expand All @@ -9,7 +9,7 @@ Building and Installing
-----------------------

```shell
npm install phantomjs
npm install phantomjs-prebuilt
```

Or grab the source and
Expand All @@ -22,11 +22,6 @@ What this installer is really doing is just grabbing a particular "blessed" (by
this module) version of Phantom. As new versions of Phantom are released
and vetted, this module will be updated accordingly.

The package has been set up to fetch and run Phantom for MacOS (darwin),
Linux based platforms (as identified by nodejs), and -- as of version 0.2.0 --
Windows (thanks to [Domenic Denicola](https://github.com/domenic)). If you
spot any platform weirdnesses, let us know or send a patch.

Running
-------

Expand All @@ -48,7 +43,7 @@ Below is an example of using this package via node.
```javascript
var path = require('path')
var childProcess = require('child_process')
var phantomjs = require('phantomjs')
var phantomjs = require('phantomjs-prebuilt')
var binPath = phantomjs.path

var childArgs = [
Expand All @@ -69,6 +64,10 @@ The major and minor number tracks the version of PhantomJS that will be
installed. The patch number is incremented when there is either an installer
update or a patch build of the phantom binary.

Pre-2.0, this package was published to NPM as [https://www.npmjs.com/package/phantomjs](phantomjs).
We changed the name to [https://www.npmjs.com/package/phantomjs-prebuilt](phantomjs-prebuilt) at
the request of PhantomJS team.

Deciding Where To Get PhantomJS
-------------------------------

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "phantomjs",
"name": "phantomjs-prebuilt",
"version": "2.1.2",
"keywords": [
"phantomjs",
Expand Down

0 comments on commit 304f64a

Please sign in to comment.