Skip to content

Commit cf69743

Browse files
Remove DOI badge, replace github release with PyPI badge, add disclaimer
1 parent 4fd2231 commit cf69743

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

README.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,31 @@
33
<!-- TODO-TEMPLATE: README BADGES
44
55
- The first badge links to the PropLib Wiki and does not need to be edited
6-
- The second badge automatically displays and links to the most recent GitHub Release.
7-
- Make sure to update the [gh-releases-badge] and [gh-releases-link] URLs with your repo name
8-
- The third badge links to the zenodo DOI page. Only include this badge if a DOI exists for a release.
9-
- Update the [doi-link] using the "id" from https://api.github.com/repos/ntia/{repo_name}. For example, the
10-
[doi-link] for ITM would be https://zenodo.org/badge/latestdoi/218981682. Using the repository ID in this link
11-
will automatically make the link always point to the most recent DOI for the repository, so this won't need to be
12-
edited every time a new release is made.
13-
- Update the [doi-badge] to include the "all versions" DOI which always points to the latest version.
14-
This can be found when creating the DOI in zenodo. The slash in the DOI must be replaced with "%2F" to
15-
render in the badge. For example, the P2108 DOI is 10.5281/zenodo.7114033 which must be input as
16-
"10.5281%2Fzenodo.7114033"
17-
- The fourth badge is the Tox GitHub actions status.
6+
- The second badge automatically displays and links to the most recent PyPI Release.
7+
- Make sure to update the [pypi-release-badge] and [pypi-release-link] URLs with
8+
your package name on PyPI (NOT the repository name on GitHub!)
9+
- This can only be added once there is a published version of the package on PyPI
10+
- The third badge is the Tox GitHub actions status.
1811
- Update the repository name in [gh-actions-test-badge] and [gh-actions-test-link]
19-
- The fifth badge displays open GitHub Issues
12+
- The fourth badge displays open GitHub Issues
2013
- Update the repository name in [gh-issues-badge]
2114
- Update the repository name in [gh-issues-link]
2215
-->
2316
[![NTIA/ITS PropLib][proplib-badge]][proplib-link]
2417
<!--
2518
[![GitHub Release][gh-releases-badge]][gh-releases-link]
26-
[![DOI][doi-badge]][doi-link]
19+
[![PyPI Release][pypi-release-badge]][pypi-release-link]
2720
[![GitHub Actions Unit Test Status][gh-actions-test-badge]][gh-actions-test-link]
2821
[![GitHub Issues][gh-issues-badge]][gh-issues-link]
2922
-->
3023
[proplib-badge]: https://img.shields.io/badge/PropLib-badge?label=%F0%9F%87%BA%F0%9F%87%B8%20NTIA%2FITS&labelColor=162E51&color=D63E04
3124
[proplib-link]: https://ntia.github.io/propagation-library-wiki
32-
[gh-actions-test-badge]: https://img.shields.io/github/actions/workflow/status/NTIA/TODO-TEMPLATE/tox.yml?branch=main&logo=pytest&logoColor=ffffff&label=Build%2FTests&labelColor=162E51
25+
[gh-actions-test-badge]: https://img.shields.io/github/actions/workflow/status/NTIA/TODO-TEMPLATE/tox.yml?branch=main&logo=pytest&logoColor=ffffff&label=Tests&labelColor=162E51
3326
[gh-actions-test-link]: https://github.com/NTIA/TODO-TEMPLATE/actions/workflows/tox.yml
34-
[gh-releases-badge]: https://img.shields.io/github/v/release/NTIA/TODO-TEMPLATE?logo=github&label=Release&labelColor=162E51&color=D63E04
35-
[gh-releases-link]: https://github.com/NTIA/TODO-TEMPLATE/releases
27+
[pypi-release-badge]: https://img.shields.io/pypi/v/TODO-TEMPLATE?logo=pypi&logoColor=ffffff&label=Release&labelColor=162E51&color=D63E04
28+
[pypi-release-link]: https://pypi.org/project/TODO-TEMPLATE
3629
[gh-issues-badge]: https://img.shields.io/github/issues/NTIA/TODO-TEMPLATE?logo=github&label=Issues&labelColor=162E51
3730
[gh-issues-link]: https://github.com/NTIA/TODO-TEMPLATE/issues
38-
[doi-badge]: https://img.shields.io/badge/{TODO-TEMPLATE-ALL-VERSIONS-DOI}-x?logo=doi&logoColor=ffffff&labelColor=162E51&color=D63E04
39-
[doi-link]: https://zenodo.org/badge/latestdoi/{TODO-TEMPLATE-REPOSITORY-ID}
4031

4132
<!-- TODO-TEMPLATE: Replace the below description with one for your software -->
4233
This code repository is a template repository for Python wrappers in the NTIA/ITS
@@ -62,7 +53,11 @@ For questions about using this template repository, contact <[email protected]
6253
6354
TODO-TEMPLATE: Update links in this section
6455
65-
This software is distributed on [PyPi](https://pypi.org/project/TODO-TEMPLATE) and is easily installable
56+
> [!NOTE]
57+
> The text below indicates this package is distributed on PyPi,
58+
> however it is not yet uploaded. A link will be provided here when available.
59+
60+
This software is distributed on [PyPi](#) and is easily installable
6661
using the following command.
6762
6863
```cmd

0 commit comments

Comments
 (0)