Skip to content

Commit 6938f2d

Browse files
committed
Update README
1 parent 51cec91 commit 6938f2d

File tree

2 files changed

+21
-17
lines changed

2 files changed

+21
-17
lines changed

LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2014 Brian E. Granger
3+
Copyright (c) 2014-2018, Project Jupyter Contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

README.md

+19-15
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
ipyleaflet
2-
==========
1+
# ipyleaflet
2+
3+
[![Documentation](http://readthedocs.org/projects/ipyleaflet/badge/?version=latest)](https://ipyleaflet.readthedocs.io/en/latest/?badge=latest)
4+
[![Binder](https://img.shields.io/badge/launch-binder-brightgreen.svg)](https://mybinder.org/v2/gh/jupyter-widgets/ipyleaflet/0.8.1?filepath=examples)
5+
[![Join the Gitter Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jupyter-widgets/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
36

47
A Jupyter / Leaflet bridge enabling interactive maps in the Jupyter notebook.
58

6-
![Screenshot](/screenshot.png)
9+
## Usage
710

8-
Getting Started
9-
---------------
11+
![Screenshot](/screenshot.png)
1012

11-
### Try it online with [Binder](http://mybinder.org/)
13+
## Installation
1214

13-
[![Binder](https://img.shields.io/badge/launch-binder-brightgreen.svg)](https://mybinder.org/v2/gh/jupyter-widgets/ipyleaflet/0.8.1?filepath=examples)
15+
Using conda:
1416

15-
Installation
16-
------------
17+
```
18+
$ conda install -c conda-forge ipyleaflet
19+
```
1720

1821
Using pip:
1922

@@ -23,18 +26,14 @@ $ jupyter nbextension enable --py --sys-prefix ipyleaflet # can be skipped for
2326
notebook 5.3 and above
2427
```
2528

26-
Using conda:
27-
28-
```
29-
$ conda install -c conda-forge ipyleaflet
30-
```
31-
3229
If you have JupyterLab, you will also need to install the JupyterLab extension:
3330

3431
```
3532
$ jupyter labextension install jupyter-leaflet
3633
```
3734

35+
## Installation from sources
36+
3837
For a development installation (requires npm):
3938

4039
```
@@ -49,4 +48,9 @@ Note for developers: the `--symlink` argument on Linux or OS X allows one to
4948
modify the JavaScript code in-place. This feature is not available
5049
with Windows.
5150

51+
## License
52+
53+
We use a shared copyright model that enables all contributors to maintain the
54+
copyright on their contributions.
5255

56+
This software is licensed under the BSD-3-Clause license. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)