Skip to content

Commit 223e54b

Browse files
authored
docs: 📝 add logo to README file (#225)
# Description Plus other small fixes to README. Closes #222 Needs a quick review. ## Checklist - [x] Formatted Markdown - [x] Ran `just run-all`
1 parent 360338f commit 223e54b

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
<!-- NOTE: This README.md is auto-generated from README.qmd. Edit that file. -->
44

5-
# `check-datapackage`: Ensure the compliance of your Data Package metadata
5+
<p align="center">
6+
<a href="https://check-datapackage.seedcase-project.org/">
7+
<img src="https://raw.githubusercontent.com/seedcase-project/check-datapackage/main/_extensions/seedcase-project/seedcase-theme/logos/navbar-logo-check-datapackage.svg" alt="Link to Sprout website" height="150"/>
8+
</a>
9+
</p>
10+
11+
# check-datapackage: Ensure the compliance of your Data Package metadata
612

713
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17733655.svg)](https://doi.org/10.5281/zenodo.17733655)
814
[![PyPI
@@ -31,7 +37,7 @@ state and is being actively
3137
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
3238

3339
`check-datapackage` is a Python package that checks your Data Package’s
34-
metadata against the [Data Package standard](https://datapackage.org/),
40+
metadata against the [Data Package standard](https://datapackage.org/)
3541
to ensure that it’s compliant with the standard. Specifically, it:
3642

3743
- Checks your metadata in `datapackage.json` against the Data Package
@@ -47,9 +53,9 @@ to ensure that it’s compliant with the standard. Specifically, it:
4753

4854
> [!WARNING]
4955
>
50-
> `check-datapackage` only checks the metadata in your datapackage.json
51-
> file against the Data Package standard—it does not check the data
52-
> itself against the metadata.
56+
> `check-datapackage` only checks the metadata in your
57+
> `datapackage.json` file against the Data Package standard—it does not
58+
> check the data itself against the metadata.
5359
5460
> [!TIP]
5561
>

README.qmd

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,20 @@ metadata-files:
66

77
<!-- NOTE: This README.md is auto-generated from README.qmd. Edit that file. -->
88

9-
# `{{< meta gh.repo >}}`: Ensure the compliance of your Data Package metadata
9+
```{=html}
10+
<p align="center">
11+
<a href="https://check-datapackage.seedcase-project.org/">
12+
<img src="https://raw.githubusercontent.com/seedcase-project/check-datapackage/main/_extensions/seedcase-project/seedcase-theme/logos/navbar-logo-check-datapackage.svg" alt="Link to Sprout website" height="150"/>
13+
</a>
14+
</p>
15+
```
16+
17+
# {{< meta gh.repo >}}: Ensure the compliance of your Data Package metadata
1018

1119
{{< include /docs/includes/_badges.qmd >}}
1220

13-
`check-datapackage` is a Python package that checks your Data Packages
14-
metadata against the [Data Package standard](https://datapackage.org/),
21+
`check-datapackage` is a Python package that checks your Data Package's
22+
metadata against the [Data Package standard](https://datapackage.org/)
1523
to ensure that it's compliant with the standard. Specifically, it:
1624

1725
- Checks your metadata in `datapackage.json` against the Data Package
@@ -26,7 +34,7 @@ to ensure that it's compliant with the standard. Specifically, it:
2634
standard, including properties that must and should be included.
2735

2836
::: callout-warning
29-
`check-datapackage` only checks the metadata in your datapackage.json
37+
`check-datapackage` only checks the metadata in your `datapackage.json`
3038
file against the Data Package standard---it does not check the data
3139
itself against the metadata.
3240
:::

0 commit comments

Comments
 (0)