Skip to content

Commit 462de86

Browse files
committed
Document new testing option.
1 parent 16ac0b8 commit 462de86

File tree

3 files changed

+17
-5
lines changed

3 files changed

+17
-5
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
Based on [GPXParser.js](https://github.com/Luuka/GPXParser.js), which has been unmaintained, this updated library is intended to bring modern JavaScript features to GPX parsing, including extensions in tracks and fully featured typescript support.
44

5-
_I'm also open to any improvements or suggestions with the library, so feel free to leave an issue._
5+
_I'm also open to any improvements or suggestions with the library, so feel free to leave an issue ([Contributing](#contribution))._
66

77
## GPX Schema
88

99
The schema for GPX, a commonly used gps tracking format, can be found here: [GPX 1.1](https://www.topografix.com/gpx.asp).
1010

11+
See [Documentation](#documentation) for more details on how GPX data is represented by the library.
12+
1113
# Usage
1214

13-
**This library currently does not include support for non-browser execution.**
15+
**This library does include support for non-browser execution.**
1416

1517
Right now, to use this in Node.js without a browser or in something like React Native, use [`xmldom-qsa`](https://www.npmjs.com/package/xmldom-qsa) instead.
1618

@@ -110,6 +112,16 @@ const [parsedFile, error] = parseGPXWithCustomParser(
110112
)
111113
```
112114

115+
# Contribution
116+
117+
If you are having an issue and aren't sure how to resolve it, feel free to leave an issue.
118+
119+
If you do know how to fix it, please leave a PR, as I cannot guarantee how soon I can address the issue myself.
120+
121+
I do try to be responsive to PRs though, so if you leave one I'll try to get it merged asap.
122+
123+
Also, there are some basic tests built in to the library, so please test your code before you try to get it merged (_just to make sure everything is backwards compatible_). Use `npm run test` to do this.
124+
113125
# Documentation
114126

115127
These descriptions are adapted from [GPXParser.js](https://github.com/Luuka/GPXParser.js), with minor modifications.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@we-gold/gpxjs",
33
"author": "Weaver Goldman <we.goldm@gmail.com>",
44
"description": "GPX.js is a modern library for parsing GPX files and converting them to GeoJSON.",
5-
"version": "1.0.7",
5+
"version": "1.0.8",
66
"type": "module",
77
"license": "MIT",
88
"repository": {

0 commit comments

Comments
 (0)