feat: npm install -g ttyper
This PR intends to add npm install -g ttyper as an installation strategy for Ttyper. Since NPM is the most used package manager, this would be a valuable addition to the project.
https://www.npmjs.com/package/ttyper
Here's how this works:
When npm install is run, NPM executes the install script, i.e. install.js.
The install.js file:
- Downloads the appropriate binary from GitHub releases and moves it to the
bindirectory. - Removes the
node_moduleswith the tar and zip libraries, as they are not needed any further. - NPM symlinks the package name
ttyper, to whatever is set as thebinvalue in thepackage.json. - We configure
binto runrunner.js, which handles the running of our downloaded binary.
The added npm-release Action job:
- Bumps the version number value in the
package.jsonto be in parity with the release version. - Copies the
README.mdfrom the root dir to be displayed on the package's homepage. - Publishes the package to NPM.
We can commit the version bump if we need to, but that would be an extra commit.
A successful run of this workflow can be found here.
@max-niederman, I'll move the NPM package to you and you can configure the NPM_ACCESS_TOKEN secret for this repository.
Hey @max-niederman, could you please review when you're available? Thanks.
Hi @max-niederman. Welcome back. I'll take a look.
Hi @max-niederman. Could you try npm install -g ttyper and ttyper on your device now?