feat: release as bin, proper README, proper package

This commit is contained in:
HugoPoi 2021-02-19 23:30:18 +01:00
parent 0c5b9b5464
commit 94103d3604
5 changed files with 69 additions and 8 deletions

View File

@ -0,0 +1,3 @@
{
"extends": "npm-package-json-lint-config-default"
}

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# GoPro Telemetry Exporter
A cli tool to export GoPro metadatas from video files.
## Usage
`gopro-telemetry-exporter --input GPX010001.MP4 --output GPX010001.gpx --GPS5Fix 3 --preset gpx --groupTimes 200`
* `--input` is the path of the GoPro video file
* `--output` is the path to metadatas output file ( can be gpx, kml,
geojson, csv, mgjson, virb, and other format that can be supported by
[GoPro Telemetry Presets](https://www.npmjs.com/package/gopro-telemetry#user-content-presets))
* All other options will be pass directly to [GoPro Telemetry](), you
can check the list
## TODO
* Check all the presets
* Implement progress
https://www.npmjs.com/package/gopro-telemetry

View File

@ -1,4 +1,7 @@
#!/bin/node #!/usr/bin/env node
'use strict';
const gpmfExtract = require('gpmf-extract'); const gpmfExtract = require('gpmf-extract');
const goproTelemetry = require(`gopro-telemetry`); const goproTelemetry = require(`gopro-telemetry`);
const fs = require('fs'); const fs = require('fs');

8
package-lock.json generated
View File

@ -1,5 +1,5 @@
{ {
"name": "gopro-extract", "name": "gopro-telemetry-exporter",
"version": "1.0.0", "version": "1.0.0",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
@ -3166,6 +3166,12 @@
} }
} }
}, },
"npm-package-json-lint-config-default": {
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/npm-package-json-lint-config-default/-/npm-package-json-lint-config-default-3.0.0.tgz",
"integrity": "sha512-1eOHUSg4Pg1lDp75NJ/pTnYU3/vn7WIL+3MG5KWtrUEFtIuBX/yLGABTFZ4+sP73bQYu/Nla07icJjezQP6SnA==",
"dev": true
},
"rfc4648": { "rfc4648": {
"version": "1.4.0", "version": "1.4.0",
"resolved": "https://registry.npmjs.org/rfc4648/-/rfc4648-1.4.0.tgz", "resolved": "https://registry.npmjs.org/rfc4648/-/rfc4648-1.4.0.tgz",

View File

@ -1,18 +1,46 @@
{ {
"name": "gopro-extract", "name": "gopro-telemetry-exporter",
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "A cli tool to parse telemetry from the GPMF track in GoPro cameras (Hero5 and later).",
"main": "gpx-extract.js", "keywords": [
"GoPro",
"GPS",
"GPMF",
"mgjson",
"GPX",
"CSV",
"KML",
"geojson",
"accelerometer",
"gyroscope",
"telemetry",
"metadata",
"sensors",
"converter",
"parser",
"cli"
],
"repository": {
"type": "git",
"url": "https://home.hugopoi.net/gitea/hugopoi/gopro-telemetry-exporter.git"
},
"homepage": "https://home.hugopoi.net/gitea/hugopoi/gopro-telemetry-exporter",
"bin": "./bin/gopro-telemetry-exporter.js",
"dependencies": { "dependencies": {
"gopro-telemetry": "^1.1.34", "gopro-telemetry": "^1.1.34",
"gpmf-extract": "^0.1.21", "gpmf-extract": "^0.1.21",
"lodash": "^4.17.20", "lodash": "^4.17.20",
"minimist": "^1.2.5" "minimist": "^1.2.5"
}, },
"devDependencies": {}, "devDependencies": {
"npm-package-json-lint-config-default": "^3.0.0"
},
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
}, },
"author": "", "author": {
"license": "ISC" "name": "HugoPoi",
"url": "https://blog.hugopoi.net/"
},
"license": "GPL-3.0-or-later"
} }