Skip to content

Commit 9057887

Browse files
Readme (#37)
* changed Readme * reducing the size of the gif
1 parent 13989f0 commit 9057887

File tree

4 files changed

+46
-3
lines changed

4 files changed

+46
-3
lines changed

README.md

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,36 @@
11
# ipyopenlayers
22

3-
[![Build Status](https://travis-ci.org/QuantStack/ipyopenlayers.svg?branch=master)](https://travis-ci.org/QuantStack/ipyopenlayers)
4-
[![codecov](https://codecov.io/gh/QuantStack/ipyopenlayers/branch/master/graph/badge.svg)](https://codecov.io/gh/QuantStack/ipyopenlayers)
3+
[![Documentation](http://readthedocs.org/projects/ipyopenlayers/badge/?version=latest)](https://ipyopenlayers.readthedocs.io/en/latest/?badge=latest)
4+
[![JupyterLite Badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://ipyopenlayers.readthedocs.io/en/latest/lite/lab/index.html)
55

6-
OpenLayers Jupyter Widget
6+
A Jupyter / Openlayers bridge enabling interactive maps in the Jupyter notebook.
7+
8+
## Usage
9+
10+
### Adding Raster Tile Layers and Controlling Zoom on the Map
11+
12+
![Zoom Raster](https://github.com/Nour-Cheour10/Ipy-openlayers/blob/Readme/media/RasterZoom.gif)
13+
14+
This GIF demonstrates how to add Raster Tile layers to the map and control the zoom functionality.
15+
16+
### Adding Vector Tile Layers and Changing Their Style
17+
18+
![Exemple de Vecteur](https://github.com/Nour-Cheour10/Ipy-openlayers/blob/Readme/media/Vector.gif)
19+
20+
This GIF shows how to add Vector Tile layers to the map and modify their style.
21+
22+
### GeoJSON Layer
23+
24+
![Exemple GeoJson](https://github.com/Nour-Cheour10/Ipy-openlayers/blob/Readme/media/GeoJson.png)
25+
26+
This image illustrates how to add a GeoJSON layer to the map.
27+
28+
29+
## Example Repository
30+
31+
For a real-world example of how to use `ipyopenlayers`, check out this [electricity dashboard project](https://github.com/Nour-Cheour10/electricitymap_dashboard.git).
32+
33+
This project showcases the integration of `ipyopenlayers` in an electricity dashboard application, demonstrating a use case of the library.
734

835
## Installation
936

@@ -75,6 +102,22 @@ After a change wait for the build to finish and then refresh your browser and th
75102

76103
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
77104

105+
## Documentation
106+
107+
To get started with using `ipyopenlayers`, check out the full documentation
108+
109+
https://ipyopenlayers.readthedocs.io/
110+
111+
## Try it Online
112+
113+
You can try ipyopenlayers below, or open many other live examples in a new browser tab with JupyterLite.
114+
115+
- [JupyterLite](https://ipyopenlayers.readthedocs.io/en/latest/lite/lab/index.html)
116+
117+
[![JupyterLite Badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://ipyopenlayers.readthedocs.io/en/latest/lite/lab/index.html)
118+
119+
120+
78121
## Updating the version
79122

80123
To update the version, install tbump and use it to bump the version.

media/GeoJson.png

254 KB
Loading

media/RasterZoom.gif

29.6 MB
Loading

media/Vector.gif

40.6 MB
Loading

0 commit comments

Comments
 (0)