Skip to content

Commit

Permalink
Add version updates for npm packages to dependabot, and also update R…
Browse files Browse the repository at this point in the history
…EADME.md as ffi-napi supports prebuilt binaries.
  • Loading branch information
blu3mania committed Sep 29, 2023
1 parent 096c962 commit be43c74
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,9 @@ updates:
schedule:
# Check for updates to GitHub actions once a week
interval: "weekly"

- package-ecosystem: "npm"
directory: "/"
schedule:
# Check for updates to packages once a week
interval: "weekly"
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,20 @@ CommonJS branch.

## Run these steps first:

1. One of the packages, "ffi-napi", uses native modules and relies on "node-gyp" to build the project. As a
result, there are some prerequisites that need to be installed/configured. Please refer to [node-gyp's
instructions](https://github.com/nodejs/node-gyp#installation).
1. One of the packages, "ffi-napi", uses native modules and relies on "node-gyp" to build the project if needed,
depending on whether a prebuilt binary exists or not. As a result, there may be some prerequisites that are
needed to be installed/configured. The recommendation is to try to install this package first, and if it ends
up building the native binary on the fly and node-gyp complains about something, then refer to
[node-gyp's instructions](https://github.com/nodejs/node-gyp#installation) to have those prerequisites installed.

2. Run "npm run show \[addessFamily\]" or "node src/show-interfaces.js \[addessFamily\]".

addessFamily is optional, which can be "ipv4" or "ipv6" if you only care about one type of IP address.
Shortened forms of parameter are accepted as well, which are "4", "6", "v4", "v6".

Find the network interface you want to monitor, and note down the key to that interface, e.g. "Local Area
Connection", "Wi-Fi".

3. Edit src/settings.json.
* service defines service parameters when installed as Windows service:
* name is the service name to be used.
Expand Down Expand Up @@ -68,6 +72,7 @@ CommonJS branch.

Supported values are: "DNS Registration", "Scheduled DNS Registration", "IP Changed", "IP Assigned", "IP
Removed".

4. Run "npm install". Accept UAC prompts if any (there could be up to 4). "npm link" can be used as well,
which will create a command "showip" that can be used as a shortcut to "src/show-interfaces.js".

Expand Down

0 comments on commit be43c74

Please sign in to comment.