diff --git a/README.md b/README.md index 46eb16d..db7a9d5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,34 @@ [![Build Status](https://travis-ci.org/QuantStack/ipyopenlayers.svg?branch=master)](https://travis-ci.org/QuantStack/ipyopenlayers) [![codecov](https://codecov.io/gh/QuantStack/ipyopenlayers/branch/master/graph/badge.svg)](https://codecov.io/gh/QuantStack/ipyopenlayers) -OpenLayers Jupyter Widget +A Jupyter / Openlayers bridge enabling interactive maps in the Jupyter notebook. + +## Usage + +### Adding Raster Tile Layers and Controlling Zoom on the Map + +![Zoom Raster](https://github.com/Nour-Cheour10/Ipy-openlayers/blob/Readme/media/RasterZoom.gif) + +This GIF demonstrates how to add Raster Tile layers to the map and control the zoom functionality. + +### Adding Vector Tile Layers and Changing Their Style + +![Exemple de Vecteur](https://github.com/Nour-Cheour10/Ipy-openlayers/blob/Readme/media/Vector.gif) + +This GIF shows how to add Vector Tile layers to the map and modify their style. + +### GeoJSON Layer + +![Exemple GeoJson](https://github.com/Nour-Cheour10/Ipy-openlayers/blob/Readme/media/GeoJson.png) + +This image illustrates how to add a GeoJSON layer to the map. + + +## Example Repository + +For a real-world example of how to use `ipyopenlayers`, check out this [electricity dashboard project](https://github.com/Nour-Cheour10/electricitymap_dashboard.git). + +This project showcases the integration of `ipyopenlayers` in an electricity dashboard application, demonstrating a use case of the library. ## Installation diff --git a/media/GeoJson.png b/media/GeoJson.png new file mode 100644 index 0000000..5234945 Binary files /dev/null and b/media/GeoJson.png differ diff --git a/media/RasterZoom.gif b/media/RasterZoom.gif new file mode 100644 index 0000000..0465c7a Binary files /dev/null and b/media/RasterZoom.gif differ diff --git a/media/Vector.gif b/media/Vector.gif new file mode 100644 index 0000000..40be53a Binary files /dev/null and b/media/Vector.gif differ