Skip to content

Commit

Permalink
Readme doc updated
Browse files Browse the repository at this point in the history
  • Loading branch information
sethlu committed Feb 15, 2016
1 parent a01b00b commit d01175b
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,18 @@ For details on the optional flags, run `electron-osx-sign --help` or see [electr

```javascript
var sign = require('electron-osx-sign')
sign(opts[, function callback (err) {}])
sign(opts[, function done (err) {}])
```

Example:

##### sign(opts, callback)

```javascript
var sign = require('electron-osx-sign')
sign({
app: 'path/to/my.app'
}, function callback (err) {
}, function done (err) {
if (err) {
// Handle the error
return;
Expand All @@ -56,8 +58,6 @@ sign({
})
```

##### sign(opts, callback)

###### opts

**Required**
Expand Down Expand Up @@ -114,7 +114,7 @@ Default to detect from application package.
Path to `Electron Helper NP`, which may be renamed, in `Electron Helper NP.app`.
Default to detect from application package.

*Note: `helper-path`, `helper-eh-path`, `helper-np-path` needn't provided unless error thrown for not able to find any of them automatically.*
*Note: `helper-path`, `helper-executable-path`, `helper-eh-path`, `helper-eh-executable-path`, `helper-np-path`, `helper-np-executable-path` needn't provided unless error thrown for not able to find any of them automatically.*

`identity` - *String*

Expand Down Expand Up @@ -156,6 +156,8 @@ For details on the optional flags, run `electron-osx-flat --help` or see [electr

#### From the API

##### flat(opts, callback)

```javascript
var flat = require('electron-osx-sign').flat
flat(opts[, function done (err) {}])
Expand All @@ -176,8 +178,6 @@ flat({
})
```

##### flat(opts, callback)

###### opts

**Required**
Expand Down

0 comments on commit d01175b

Please sign in to comment.