Skip to content

Commit

Permalink
chore(terra-draw): use a custom README for the terra-draw package (#460)
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesLMilner authored Feb 3, 2025
1 parent cd4d2c1 commit 4ccd4b5
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/terra-draw-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,6 @@ jobs:
- name: Push tags upstream
run: git push origin main --tags

- name: Copy README.md
run: cp README.md ./packages/terra-draw

- run: npm publish
working-directory: ./packages/terra-draw
env:
Expand Down
36 changes: 36 additions & 0 deletions packages/terra-draw/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./assets/logo-dark-mode.png">
<source media="(prefers-color-scheme: light)" srcset="./assets/logo.png">
<img alt="Terra Draw logo" src="./assets/logo.png" width="400px">
</picture>

<p></p>

![Terra Draw CI Badge](https://github.com/JamesLMilner/terra-draw/actions/workflows/ci.yml/badge.svg)
[![npm version](https://badge.fury.io/js/terra-draw.svg)](https://badge.fury.io/js/terra-draw)

Frictionless map drawing across mapping libraries.

Terra Draw centralizes map drawing logic and provides a host of out-of-the-box drawing modes that work across different JavaScript mapping libraries. It also allows you to bring your own modes!

### Supported Mapping Libraries

Terra Draw works with your mapping library of choice via adapters. Please pick the adapter for the mapping library you are working with:

* [terra-draw-maplibre-gl-js-adapter](https://www.npmjs.com/package/terra-draw-maplibre-gl-js-adapter)
* [terra-draw-leaflet-adapter](https://www.npmjs.com/package/terra-draw-leaflet-adapter)
* [terra-draw-google-maps-adapter](https://www.npmjs.com/package/terra-draw-googl-emaps-adapter)
* [terra-draw-mapbox-gl-js-adapter](https://www.npmjs.com/package/terra-draw-mapbox-gl-js-adapter)
* [terra-draw-google-maps-adapter](https://www.npmjs.com/package/terra-draw-google-maps-adapter)
* [terra-draw-arcgis-adapter](https://www.npmjs.com/package/terra-draw-arcgis-adapter)

### Getting Started

* [Getting started guide](https://github.com/JamesLMilner/terra-draw/blob/main/guides/1.GETTING_STARTED.md)
* [API Docs](https://terradraw.io/#/api)
* [Repository](https://www.github.com/JamesLMilner/terra-draw)
* [Website](https://www.terradraw.io)

### License

MIT

0 comments on commit 4ccd4b5

Please sign in to comment.