Skip to content

Commit 18f25bd

Browse files
committed
[README] Link to API docs
1 parent cb93cef commit 18f25bd

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
[![CI](https://github.com/mshroyer/coursepointer/actions/workflows/ci.yml/badge.svg)](https://github.com/mshroyer/coursepointer/actions/workflows/ci.yml)
22
[![Crates.io](https://img.shields.io/crates/v/coursepointer.svg)](https://crates.io/crates/coursepointer)
3+
[![API Docs](https://docs.rs/coursepointer/badge.svg)](https://docs.rs/coursepointer)
34

45
# CoursePointer
56

6-
A command-line tool that converts GPX routes/tracks and waypoints into Garmin
7-
FIT course files with [course
7+
A command-line tool and library that converts GPX routes/tracks and waypoints
8+
into Garmin FIT course files with [course
89
points](https://support.garmin.com/en-US/?faq=aisqGZTLwH5LvbExSdO6L6). This
910
lets your waypoints appear in [Up
1011
Ahead](https://support.garmin.com/en-US/?faq=lQMibRoY2I5Y4pP8EXgxv7) on
@@ -15,6 +16,9 @@ This provides a way to author courses in third-party applications that don't
1516
export to course points, while still using Up Ahead functionality as though
1617
the course had been created in Garmin Connect.
1718

19+
The library also offers some lower-level features for building arbitrary FIT
20+
courses. See [the API docs](https://docs.rs/coursepointer) for details.
21+
1822
## Usage example
1923

2024
When planning a hiking route on [Gaia GPS](https://gaiagps.com/), you can put

0 commit comments

Comments
 (0)