Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken headings in Markdown files #119

Merged
merged 1 commit into from
May 15, 2023
Merged

Fix broken headings in Markdown files #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Covered by tests and works for [linux](http://screencast.com/t/Je2ptbHhP), [wind
## API

<a name="new_updater"></a>
####new updater(manifest, options)
#### new updater(manifest, options)
Creates new instance of updater. Manifest could be a `package.json` of project.

Note that compressed apps are assumed to be downloaded in the format produced by [node-webkit-builder](https://github.com/mllrsohn/node-webkit-builder) (or [grunt-node-webkit-builder](https://github.com/mllrsohn/grunt-node-webkit-builder)).
Expand All @@ -40,7 +40,7 @@ Note that compressed apps are assumed to be downloaded in the format produced by
- options `object` - Optional

<a name="updater#checkNewVersion"></a>
####updater.checkNewVersion(cb)
#### updater.checkNewVersion(cb)
Will check the latest available version of the application by requesting the manifest specified in `manifestUrl`.

The callback will always be called; the second parameter indicates whether or not there's a newer version.
Expand All @@ -51,7 +51,7 @@ This function assumes you use [Semantic Versioning](http://semver.org) and enfor
- cb `function` - Callback arguments: error, newerVersionExists (`Boolean`), remoteManifest

<a name="updater#download"></a>
####updater.download(cb, newManifest)
#### updater.download(cb, newManifest)
Downloads the new app to a template folder

**Params**
Expand All @@ -61,17 +61,17 @@ Downloads the new app to a template folder

**Returns**: `Request` - Request - stream, the stream contains `manifest` property with new manifest and 'content-length' property with the size of package.
<a name="updater#getAppPath"></a>
####updater.getAppPath()
#### updater.getAppPath()
Returns executed application path

**Returns**: `string`
<a name="updater#getAppExec"></a>
####updater.getAppExec()
#### updater.getAppExec()
Returns current application executable

**Returns**: `string`
<a name="updater#unpack"></a>
####updater.unpack(filename, cb, manifest)
#### updater.unpack(filename, cb, manifest)
Will unpack the `filename` in temporary folder.
For Windows, [unzip](https://www.mkssoftware.com/docs/man1/unzip.1.asp) is used (which is [not signed](https://github.com/edjafarov/node-webkit-updater/issues/68)).

Expand All @@ -82,7 +82,7 @@ For Windows, [unzip](https://www.mkssoftware.com/docs/man1/unzip.1.asp) is used
- manifest `object`

<a name="updater#runInstaller"></a>
####updater.runInstaller(appPath, args, options)
#### updater.runInstaller(appPath, args, options)
Runs installer

**Params**
Expand All @@ -93,7 +93,7 @@ Runs installer

**Returns**: `function`
<a name="updater#install"></a>
####updater.install(copyPath, cb)
#### updater.install(copyPath, cb)
Installs the app (copies current application to `copyPath`)

**Params**
Expand All @@ -102,7 +102,7 @@ Installs the app (copies current application to `copyPath`)
- cb `function` - Callback arguments: error

<a name="updater#run"></a>
####updater.run(execPath, args, options)
#### updater.run(execPath, args, options)
Runs the app from original app executable path.

**Params**
Expand Down