nemo
/
electron-fingerprints
mirror of https://github.com/captn3m0/electron-fingerprints.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve usage doc

This commit is contained in:
Nemo 2021-07-16 12:51:49 +05:30
parent bd2363a916
commit 24678bde49
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,4 +1,4 @@
# electron-fingerprints ![npm bundle size](https://img.shields.io/bundlephobia/minzip/electron-fingerprints) ![npm](https://img.shields.io/npm/v/electron-fingerprints) ![NPM](https://img.shields.io/npm/l/electron-fingerprints) ![Zero Dependencies](https://img.shields.io/badge/Dependencies-Zero-blue)
# [electron-fingerprints](https://www.npmjs.com/package/electron-fingerprints) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/electron-fingerprints) ![npm](https://img.shields.io/npm/v/electron-fingerprints) ![NPM](https://img.shields.io/npm/l/electron-fingerprints) ![Zero Dependencies](https://img.shields.io/badge/Dependencies-Zero-blue)
Generates fingerprints for electron version detection by downloading electron releases and generating checksums of the files contained in each release.
@ -10,9 +10,24 @@ you get a better sense of what the application is running.
Written as the backend for [`which-electon`][we].
## install
```shell
npm install electron-fingerprints
```
## usage
This is just the raw data files, see [which-electron][we] for a usable package. The `lookup.json` file is published as the `electron-fingerprints` package on NPM.
This is just the raw data files, see [which-electron][we] for a usable package. The `lookup.json` file is published as the `electron-fingerprints` package on NPM. Programmatic usage is still possible:
```javascript
const lookup = require('electron-fingerprints')
// baf786083f482c1f035e50e105b5f7475af1e00b = sha1(ffmpeg.dll)
lookup['win32-x64']['baf786083f482c1f035e50e105b5f7475af1e00b']
// ["v1.4.3", "v1.4.4", "v1.4.5"]
```
You can sort or filter the returned versions if needed.
## supported releases
@ -24,7 +39,11 @@ All Stable electron releases for the following architectures are fingerprinted:
A list of release fingerprints is under the `hashes` directory.
## LICENSE
## todo
- [ ] Add support for darwin-arm
## license
Released under WTFPL.