Skip to content

Commit

Permalink
chore(docs): rename from node-webkit-updater to @nwutils/updater
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushmanchhabra committed Jun 9, 2024
1 parent 908c432 commit 1115368
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 14 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
> This repository is in maintainance mode. Bug fixes will be provided on a best effort basis. If you use this project, please consider contributing back.
# node-webkit-updater
# @nwutils/updater

[![npm](https://img.shields.io/npm/v/node-webkit-updater.svg?style=flat)](https://www.npmjs.com/package/node-webkit-updater)
[![Join the chat at https://gitter.im/nwjs/nwjs](https://badges.gitter.im/nwjs/nw-builder.svg)](https://gitter.im/nwjs/nw-builder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Join the chat at https://gitter.im/nwjs/nwjs](https://badges.gitter.im/nwjs/nwjs.svg)](https://gitter.im/nwjs/nwjs)

```
npm i -D node-webkit-updater
```shell
npm i @nwutils/updater
```

It gives you low-level API to:
Expand All @@ -33,7 +33,7 @@ Covered by tests and works for [linux](http://screencast.com/t/Je2ptbHhP), [wind
#### 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)).
Note that compressed apps are assumed to be downloaded in the format produced by [nw-builder](https://github.com/nwutils/nw-builder) (or [grunt-nw-builder](https://github.com/nwjs/grunt-nw-builder)).

**Params**

Expand Down
7 changes: 3 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 4 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "node-webkit-updater",
"name": "@nwutils/updater",
"description": "Update NW.js applications",
"keywords": [
"NW.js",
Expand All @@ -19,7 +19,7 @@
],
"contributors": [
{
"name": "The nw-updater Authors",
"name": "The @nwutils/updater Authors",
"url": "https://github.com/nwutils/nw-updater/graphs/contributors"
}
],
Expand All @@ -37,7 +37,7 @@
},
"scripts": {
"grunt": "grunt",
"test": "node node_modules/grunt-cli/bin/grunt clean mochaTest",
"test": "grunt clean mochaTest",
"types": "npx -p typescript tsc app/updater.js --declaration --allowJs --emitDeclarationOnly --outFile ./index.d.ts"
},
"dependencies": {
Expand All @@ -57,7 +57,6 @@
"grunt-contrib-copy": "^1.0.0",
"grunt-mocha-test": "^0.13.3",
"grunt-nw-builder": "^4.7.4",
"mocha": "^10.4.0",
"nw-builder": "^4.7.4"
"mocha": "^10.4.0"
}
}

0 comments on commit 1115368

Please sign in to comment.