Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme on unpkg; tailored for MapLibre GL JS #143

Merged
merged 1 commit into from
Jun 1, 2021
Merged

Readme on unpkg; tailored for MapLibre GL JS #143

merged 1 commit into from
Jun 1, 2021

Conversation

roblabs
Copy link
Contributor

@roblabs roblabs commented Apr 22, 2021

Launch Checklist

  • briefly describe the changes in this PR
  • This PR adds notes on unpkg; tailored for MapLibre GL JS.
  • This is useful for developers that want to fetch via unpkg a specific version (give me 1.14.0), or at least versions (give me at least 1.14.x), or latest.
  • Developers can also fetch release date, size and CHANGELOG for any version using these notes on unpkg.
  • confirm your changes do not include backports from Mapbox projects (unless with compliant license)
  • apply changelog label ('bug', 'feature', 'docs', etc) or use the label 'skip changelog'
  • add an entry inside this element for inclusion in the maplibre-gl-js changelog: add readme on unpkg versions
  • write tests for all new functionality.
  • Tested unpkg links in the readme including semver, meta

N/A:

  • include before/after visuals or gifs if this PR includes visual changes
  • document any changes to public APIs
  • post benchmark scores
  • manually test the debug page

@github-actions
Copy link
Contributor

Bundle size report:

Size Change: 0 B
Total Size Before: 205 kB
Total Size After: 205 kB

Output file Before After Change
maplibre-gl.js 196 kB 196 kB 0 B
maplibre-gl.css 8.87 kB 8.87 kB 0 B
ℹ️ View Details No major changes

@wipfli
Copy link
Member

wipfli commented Apr 23, 2021

Thanks for this @roblabs. Maybe we could add this information here as well: https://maplibre.org/maplibre-gl-js-docs/api/ ?

@roblabs
Copy link
Contributor Author

roblabs commented Apr 23, 2021

Thanks for this @roblabs. Maybe we could add this information here as well: https://maplibre.org/maplibre-gl-js-docs/api/?

Great idea @wipfli!! I've added PR maplibre/maplibre-gl-js-docs#46. I think the API Docs are a better landing page & summary of how UNPKG is used. I'll keep this README here in this repo, as it can be used for local docs for JS developers.

roblabs added a commit to maplibre/maplibre-gl-js-docs that referenced this pull request Apr 23, 2021
* Add documentation on UNPKG for use in the API Docs.  Related to maplibre/maplibre-gl-js#143

* Fix typo
@roblabs roblabs merged commit aa8507c into maplibre:main Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants