Improve README [skip ci]

This commit is contained in:
Nemo 2022-04-30 21:28:26 +05:30
parent 7001919141
commit bd5d747dec
1 changed files with 5 additions and 4 deletions

View File

@ -17,18 +17,18 @@ See [the GitHub documentation](https://docs.github.com/en/packages/working-with-
Install from the command line: Install from the command line:
```shell ```shell
npm install @captn3m0/electron-fingerprints@2022.3.31 npm install @captn3m0/electron-fingerprints
``` ```
Install via package.json: Install via package.json:
```json ```json
"@captn3m0/electron-fingerprints": "2022.3.31" "@captn3m0/electron-fingerprints": "*"
``` ```
## usage ## usage
This is just the raw data files, see [which-electron][we] for a usable package. The `lookup.json` file is published as the `@captn3m0/electron-fingerprints` package on the GitHub NPM Package Registry. Programmatic usage is still possible: This repository only contains the raw data files, see [which-electron][we] for a usable package. The `lookup.json` files are published as the `@captn3m0/electron-fingerprints` package on the GitHub NPM Package Registry as well as on [GitHub Releases][releases]. Programmatic usage is still possible:
```javascript ```javascript
const lookup = require("@captn3m0/electron-fingerprints"); const lookup = require("@captn3m0/electron-fingerprints");
@ -54,10 +54,11 @@ A list of release fingerprints is under the `hashes` directory. Releases made wh
## versioning ## versioning
Releases are versioned by YYYY.MM.DD format. Releases are versioned by the date on which they were made (as per UTC).
## license ## license
Released under WTFPL. Released under WTFPL.
[we]: https://github.com/captn3m0/which-electron [we]: https://github.com/captn3m0/which-electron
[releases]: https://github.com/captn3m0/electron-fingerprints/releases