Skip to content

Commit

Permalink
Web components README and package.json improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthetechie committed Aug 29, 2024
1 parent 115afd2 commit 2bdbd71
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
8 changes: 8 additions & 0 deletions web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Ferrostar Web Components

Ferrostar is a modern SDK for building turn-by-turn navigation applications.

This package includes web components for integrating navigation into your web applications.

Refer to the [Ferrostar User Guide](https://stadiamaps.github.io/ferrostar/)
for more info and tutorials to get started!
17 changes: 15 additions & 2 deletions web/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
{
"name": "@stadiamaps/ferrostar-webcomponents",
"version": "0.1.0",
"collaborators": [
"Ian Wagner <ian@stadiamaps.com>",
"Jacob Fielding <jacob@rallista.app>",
"Luke Seelenbinder <luke@stadiamaps.com>"
],
"version": "0.1.1",
"license": "BSD-3-Clause",
"type": "module",
"main": "./dist/ferrostar-webcomponents.js",
"module": "./dist/ferrostar-webcomponents.js",
Expand All @@ -10,6 +16,7 @@
"files": [
"dist"
],
"types": "./dist/main.d.ts",
"scripts": {
"dev": "vite --config vite.config.site.ts",
"preview": "vite preview",
Expand All @@ -32,5 +39,11 @@
"typescript": "^5.2.2",
"vite": "^5.4.1",
"vitest": "^2.0.5"
}
},
"keywords": [
"navigation",
"routing",
"valhalla",
"osrm"
]
}

0 comments on commit 2bdbd71

Please sign in to comment.