Tidying

Author: tompollard

README.md

@@ -7,27 +7,31 @@
 
 ## Introduction
 
-A Python-native package for reading, writing, processing, and plotting physiologic signal and annotation data. The core I/O functionality is based on the Waveform Database (WFDB) [specifications](https://github.com/wfdb/wfdb-spec/).
+WFDB defines a set of open standards and software tools for the storage, sharing, and analysis of physiologic signal and annotation data. It has been widely used for decades to support biomedical research, clinical studies, and education. For more information on WFDB and its various implementations, see the [WFDB website](https://wfdb.mit.edu/).
 
-This package is heavily inspired by the original [WFDB Software Package](https://www.physionet.org/content/wfdb/), and initially aimed to replicate many of its command-line APIs. However, the projects are independent, and there is no promise of consistency between the two, beyond each package adhering to the core specifications.
+This package is heavily inspired by the original [WFDB Software Package](https://www.physionet.org/content/wfdb/). It aims to replicate many of its command-line APIs in Python, but there is no promise of consistency between the two. Core I/O functionality is based on the Waveform Database (WFDB) [specifications](https://github.com/wfdb/wfdb-spec/).
 
-## Documentation and Usage
+## Resources
 
-See the [documentation site](http://wfdb.readthedocs.io) for the public APIs.
-
-See the [demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb) notebook file for example use cases.
+- WFDB Website: [https://wfdb.mit.edu/](https://wfdb.mit.edu/)
+- WFDB-Python Documentation: [http://wfdb.readthedocs.io](http://wfdb.readthedocs.io)
+- WFDB Specification: [https://github.com/wfdb/wfdb-spec/](https://github.com/wfdb/wfdb-spec/)
+- Demo Notebook: [https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb)
+- WFDB Development Repository: [https://github.com/MIT-LCP/wfdb-python](https://github.com/MIT-LCP/wfdb-python)
 
 ## Installation
 
-The distribution is hosted on PyPI at: <https://pypi.python.org/pypi/wfdb/>. The package can be directly installed from PyPI using pip:
+The distribution is hosted on PyPI at: [https://pypi.python.org/pypi/wfdb/](https://pypi.python.org/pypi/wfdb/). The package can be directly installed from PyPI using pip:
 
 ```sh
 pip install wfdb
 ```
 
 On some less-common systems, you may need to install `libsndfile` separately.  See the [soundfile installation notes](https://pypi.org/project/soundfile/) for more information.
 
-The development version is hosted at: <https://github.com/MIT-LCP/wfdb-python>. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run:
+## Development
+
+The development version is hosted at: [https://github.com/MIT-LCP/wfdb-python](https://github.com/MIT-LCP/wfdb-python). This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run:
 
 ```sh
 pip install .
@@ -39,8 +43,6 @@ If you intend to make changes to the repository, you can install additional pack
 pip install ".[dev]"
 ```
 
-## Developing
-
 Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions.
 
 ### Creating a new release
@@ -49,4 +51,4 @@ For guidance on creating a new release, see: https://github.com/MIT-LCP/wfdb-pyt
 
 ## Citing
 
-When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet.
+When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet.