Skip to content

Commit 41dbb7c

Browse files
authored
docs: update for 2.0 (#42)
BREAKING CHANGE: commit ead1083 dropped support for Node < 8. * chore: add CONTRIBUTING/support docs * docs: put building docs after API docs * docs: promisify API docs
1 parent ead1083 commit 41dbb7c

File tree

3 files changed

+38
-11
lines changed

3 files changed

+38
-11
lines changed

CONTRIBUTING.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contributing to `node-rcedit`
2+
3+
## Code of Conduct
4+
5+
This project is a part of the Electron ecosystem. As such, all contributions to this project follow [Electron's code of conduct](https://github.com/electron/electron/blob/master/CODE_OF_CONDUCT.md)
6+
where appropriate.
7+
8+
## Bugs / Feature Requests
9+
10+
Most bugs and feature requests in `node-rcedit` can be attributed to
11+
[`rcedit`](https://github.com/electron/rcedit) itself. Please look in that project's issue tracker
12+
first before filing an issue here.
13+
14+
## Releases
15+
16+
`node-rcedit` uses `semantic-release` plus a plugin named "continuous factor authentication" to
17+
publish new releases to NPM. When a pull request is merged, a new release is queued in CircleCI, and
18+
a member of the Electron [Docs & Tools Working Group](https://github.com/electron/governance/tree/master/wg-docs-tools) needs to approve it.

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,16 @@
55

66
Node module to edit resources of Windows executables.
77

8-
## Building
9-
10-
* Clone the repository
11-
* Run `npm install`
12-
* Run `npm test` to run the tests
13-
148
## Docs
159

16-
```js
17-
var rcedit = require('rcedit')
10+
```javascript
11+
const rcedit = require('rcedit')
1812
```
13+
1914
On platforms other than Windows, you will need to have [Wine](http://winehq.org)
2015
1.6 or later installed and in the system path.
2116

22-
### `rcedit(exePath, options, callback)`
17+
### `async rcedit(exePath, options)`
2318

2419
`exePath` is the path to the Windows executable to be modified.
2520

@@ -38,5 +33,10 @@ On platforms other than Windows, you will need to have [Wine](http://winehq.org)
3833
See [here](https://msdn.microsoft.com/en-us/library/windows/desktop/aa374191.aspx)
3934
for more details.
4035

41-
`callback` is the `Function` called when the command completes. The function
42-
signature is `function (error)`.
36+
Returns a `Promise` with no value.
37+
38+
## Building
39+
40+
* Clone the repository
41+
* Run `npm install`
42+
* Run `npm test` to run the tests

SUPPORT.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Support for `node-rcedit`
2+
3+
## Troubleshooting
4+
5+
This module uses the [`debug`](https://npm.im/debug) module to print out debugging information. To
6+
use it, consult your operating system's documentation on setting environment variables _([Windows
7+
notes](https://github.com/visionmedia/debug#windows-command-prompt-notes))_. Set the `DEBUG`
8+
environment variable to `rcedit`, and it will print out information, including any `STDERR` output
9+
from `rcedit.exe`.

0 commit comments

Comments
 (0)