Skip to content

Commit 6bec5fc

Browse files
authored
Merge pull request #10 from dstansby/readme-clean
Readme clean
2 parents 5c5cfd8 + d2de2b6 commit 6bec5fc

File tree

2 files changed

+12
-18
lines changed

2 files changed

+12
-18
lines changed

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,21 @@
77
[![codecov](https://codecov.io/gh/dstansby/napari-matplotlib/branch/main/graph/badge.svg)](https://codecov.io/gh/dstansby/napari-matplotlib)
88
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-matplotlib)](https://napari-hub.org/plugins/napari-matplotlib)
99

10-
A plugin to use Matplotlib with napari
10+
A plugin to create Matplotlib plots from napari layers
1111

1212
----------------------------------
1313

14-
This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.
14+
## Introduction
15+
`napari-matplotlib` is a bridge between `napari` and `matplotlib`, making it easy to create publication quality `Matplotlib` plots based on the data loaded in `napari` layers.
1516

16-
<!--
17-
Don't miss the full getting started guide to set up your new package:
18-
https://github.com/napari/cookiecutter-napari-plugin#getting-started
17+
Currently you can:
1918

20-
and review the napari docs for plugin developers:
21-
https://napari.org/plugins/stable/index.html
22-
-->
19+
- Draw histograms of individual image layers
20+
- Scatter plot two image layers against each other
21+
22+
Here's a demo of the scatter widget:
23+
24+
![](examples/short_scatter.gif)
2325

2426
## Installation
2527

@@ -36,28 +38,20 @@ To install latest development version :
3638

3739
## Contributing
3840

39-
Contributions are very welcome. Tests can be run with [tox], please ensure
41+
Contributions are very welcome! Tests can be run with [tox], please ensure
4042
the coverage at least stays the same before you submit a pull request.
4143

4244
## License
4345

4446
Distributed under the terms of the [BSD-3] license,
45-
"napari-matplotlib" is free and open source software
47+
`napari-matplotlib` is free and open source software.
4648

4749
## Issues
4850

4951
If you encounter any problems, please [file an issue] along with a detailed description.
5052

51-
[napari]: https://github.com/napari/napari
52-
[Cookiecutter]: https://github.com/audreyr/cookiecutter
5353
[@napari]: https://github.com/napari
54-
[MIT]: http://opensource.org/licenses/MIT
5554
[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
56-
[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
57-
[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
58-
[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
59-
[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
60-
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin
6155

6256
[file an issue]: https://github.com/dstansby/napari-matplotlib/issues
6357

examples/short_scatter.gif

3.12 MB
Loading

0 commit comments

Comments
 (0)