Skip to content

Commit

Permalink
Merge pull request #1 from eliquious/readme-updates
Browse files Browse the repository at this point in the history
Update readme to include more about examples and bump version
  • Loading branch information
eliquious committed Nov 16, 2015
2 parents fbc8f1b + 3265042 commit eee8202
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,27 @@ npm install --save electronify-server

When the Electron app loads, `electronify-server` will start a child process with the command you gave it in the configuration. This command is assumed to be a web server (but it doesn't have to be). If the child process was started successfully, the window will open and load the url to your server.

## Short Example
## Examples

There are a couple examples included in the repo. In order to run the examples, you need to have electron installed. If you do not have it installed, perhaps the simplest way is to use `electron-prebuilt` like so:

```
npm install -g electron-prebuilt
```

To run the examples, simply go into each example folder and run:

```
electron .
```

The `static` example has a dependency that will need to be installed first via:

```
npm install
```

### Short Example

```js
var electronify = require('electronify-server');
Expand All @@ -23,7 +43,7 @@ electronify({
});
```

## Long Example
### Long Example

```js
var electronify = require('electronify-server');
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "electronify-server",
"version": "0.1.1",
"version": "0.1.2",
"description": "electronify-server is a tool which presents local web servers in an Electron shell.",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit eee8202

Please sign in to comment.