Skip to content

Commit a2f0c26

Browse files
Update README in preparation of publication
1 parent 830cf7d commit a2f0c26

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
# Recommendation ITU-R P.2108 - U.S. Reference Implementation, Python #
22

33
[![NTIA/ITS PropLib][proplib-badge]][proplib-link]
4-
[![GitHub Release][gh-releases-badge]][gh-releases-link]
54
[![GitHub Issues][gh-issues-badge]][gh-issues-link]
5+
<!-- [![PyPI Release][pypi-release-badge]][pypi-release-link] -->
6+
<!-- [![GitHub Actions Unit Test Status][gh-actions-test-badge]][gh-actions-test-link] -->
67

78
[proplib-badge]: https://img.shields.io/badge/PropLib-badge?label=%F0%9F%87%BA%F0%9F%87%B8%20NTIA%2FITS&labelColor=162E51&color=D63E04
89
[proplib-link]: https://ntia.github.io/propagation-library-wiki
9-
<!-- [gh-actions-test-badge]: https://img.shields.io/github/actions/workflow/status/NTIA/p2108-python/tox.yml?branch=main&logo=pytest&logoColor=ffffff&label=Build%2FTests&labelColor=162E51 -->
10-
<!-- [gh-actions-test-link]: https://github.com/NTIA/p2108-python/actions/workflows/tox.yml -->
11-
[gh-releases-badge]: https://img.shields.io/github/v/release/NTIA/p2108-python?logo=github&label=Release&labelColor=162E51&color=D63E04
12-
[gh-releases-link]: https://github.com/NTIA/p2108-python/releases
10+
[gh-actions-test-badge]: https://img.shields.io/github/actions/workflow/status/NTIA/p2108-python/tox.yml?branch=main&logo=pytest&logoColor=ffffff&label=Tests&labelColor=162E51
11+
[gh-actions-test-link]: https://github.com/NTIA/p2108-python/actions/workflows/tox.yml
12+
[pypi-release-badge]: https://img.shields.io/pypi/v/proplib-p2108?logo=pypi&logoColor=ffffff&label=Release&labelColor=162E51&color=D63E04
13+
[pypi-release-link]: https://pypi.org/project/proplib-p2108
1314
[gh-issues-badge]: https://img.shields.io/github/issues/NTIA/p2108-python?logo=github&label=Issues&labelColor=162E51
1415
[gh-issues-link]: https://github.com/NTIA/p2108-python/issues
15-
<!-- [doi-badge]: https://img.shields.io/badge/{TODO-TEMPLATE-ALL-VERSIONS-DOI}-x?logo=doi&logoColor=ffffff&labelColor=162E51&color=D63E04 -->
16-
<!-- [doi-link]: https://zenodo.org/badge/latestdoi/{TODO-TEMPLATE-REPOSITORY-ID} -->
1716

1817
Python® wrapper for U.S. Reference Software Implementation of Recommendation ITU-R
1918
P.2108. This Recommendation contains three methods for the prediction of clutter
@@ -24,7 +23,11 @@ the Recommendation. This Python package wraps the
2423

2524
## Getting Started ##
2625

27-
This software is distributed on [PyPi](https://pypi.org/project/p2108) and is easily installable
26+
> [!NOTE]
27+
> The text below indicates this package is distributed on PyPi,
28+
> however it is not yet uploaded. A link will be provided here when available.
29+
30+
This software is distributed on [PyPI](#) and is easily installable
2831
using the following command.
2932

3033
```cmd

0 commit comments

Comments
 (0)