Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
noahhusby committed Sep 10, 2024
1 parent bf7caf6 commit 14941ad
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,15 @@
# aiostreammagic

#### An async python package for interfacing with Cambridge Audio / Stream Magic compatible streamers


[![](https://github.com/noahhusby/aiostreammagic/actions/workflows/publish.yml/badge.svg)](https://github.com/noahhusby/aiostreammagic/actions/workflows/build.yml)
[![](https://img.shields.io/github/license/noahhusby/aiostreammagic)](https://github.com/noahhusby/aiostreammagic/blob/main/LICENSE)
[![](https://img.shields.io/pypi/implementation/aiostreammagic
)](https://pypi.org/project/aiostreammagic/)
[![](https://img.shields.io/pypi/v/aiostreammagic
)](https://pypi.org/project/aiostreammagic/)
[![](https://img.shields.io/pypi/dm/aiostreammagic
)](https://pypi.org/project/aiostreammagic/)
[![GitHub Release][releases-shield]][releases]
[![Python Versions][python-versions-shield]][pypi]
[![Downloads][downloads-shield]][pypi]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE.md)

</div>

# About
This module implements a Python client for the Stream Magic API used to control Cambridge Audio streamers. The API connects over TCP/IP and supports several streamers, receivers, and pre-amps.

## Supported Devices
Expand All @@ -29,3 +25,16 @@ This module implements a Python client for the Stream Magic API used to control
- Cambridge Audio Edge NQ

If your model is not on the list of supported devices, and everything works correctly then add it to the list by opening a pull request.

# Installation
```shell
pip install aiostreammagic
```

[license-shield]: https://img.shields.io/github/license/noahhusby/aiostreammagic.svg
[downloads-shield]: https://img.shields.io/pypi/dm/aiostreammagic
[python-versions-shield]: https://img.shields.io/pypi/pyversions/aiostreammagic
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[releases-shield]: https://img.shields.io/github/release/noahhusby/aiostreammagic.svg
[releases]: https://github.com/noahhusby/aiostreammagic/releases
[pypi]: https://pypi.org/project/aiostreammagic/

0 comments on commit 14941ad

Please sign in to comment.