Skip to content

Commit eee8202

Browse files
committed
Merge pull request #1 from eliquious/readme-updates
Update readme to include more about examples and bump version
2 parents fbc8f1b + 3265042 commit eee8202

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,27 @@ npm install --save electronify-server
1212

1313
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.
1414

15-
## Short Example
15+
## Examples
16+
17+
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:
18+
19+
```
20+
npm install -g electron-prebuilt
21+
```
22+
23+
To run the examples, simply go into each example folder and run:
24+
25+
```
26+
electron .
27+
```
28+
29+
The `static` example has a dependency that will need to be installed first via:
30+
31+
```
32+
npm install
33+
```
34+
35+
### Short Example
1636

1737
```js
1838
var electronify = require('electronify-server');
@@ -23,7 +43,7 @@ electronify({
2343
});
2444
```
2545

26-
## Long Example
46+
### Long Example
2747

2848
```js
2949
var electronify = require('electronify-server');

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "electronify-server",
3-
"version": "0.1.1",
3+
"version": "0.1.2",
44
"description": "electronify-server is a tool which presents local web servers in an Electron shell.",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)