Skip to content

Commit 3686f02

Browse files
authored
Feature/202304 update readme (#61)
1 parent a6bf994 commit 3686f02

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,17 @@
1010
[badge-codecov]: https://codecov.io/gh/scverse/spatialdata-plot/branch/main/graph/badge.svg?token=C45F3ATSVI
1111
[link-codecov]: https://app.codecov.io/gh/scverse/spatialdata-plot
1212

13-
A very interesting piece of code
13+
The `spatialdata-plot` package extends `spatialdata` with a declarative plotting API that enables to quickly visualize `spatialdata` objects and their respective elements (i.e. `images`, `labels`, `points` and `shapes`).
14+
15+
<img src='https://raw.githubusercontent.com/scverse/spatialdata-plot/main/docs/spatialdata-plot.png'/>
1416

1517
## Getting started
1618

1719
Please refer to the [documentation][link-docs]. In particular, the
1820

1921
- [API documentation][link-api].
22+
- [Design doc][link-design-doc].
23+
- [Example notebooks][link-notebooks].
2024

2125
## Installation
2226

@@ -56,4 +60,6 @@ If you found a bug, please use the [issue tracker][issue-tracker].
5660
[issue-tracker]: https://github.com/scverse/spatialdata-plot/issues
5761
[changelog]: https://spatialdata-plot.readthedocs.io/latest/changelog.html
5862
[link-docs]: https://spatialdata-plot.readthedocs.io
59-
[link-api]: https://spatialdata-plot.readthedocs.io/latest/api.html
63+
[link-api]: https://spatialdata.scverse.org/projects/plot/en/latest
64+
[link-design-doc]: https://spatialdata.scverse.org/en/latest/design_doc.html
65+
[link-notebooks]: https://spatialdata.scverse.org/en/latest/tutorials/notebooks/notebooks.html

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ plotting.rst
1212
1313
```
1414

15-
```{toctree}
15+
<!-- ```{toctree}
1616
:hidden: true
1717
:maxdepth: 2
1818
:caption: Tutorials
1919
2020
notebooks/preprocessing
2121
notebooks/demo
2222
23-
```
23+
``` -->
2424

2525
```{toctree}
2626
:hidden: true

docs/spatialdata-plot.png

694 KB
Loading

0 commit comments

Comments
 (0)