Skip to content

Commit

Permalink
docs: improve readme (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
clement-berard authored Nov 29, 2024
1 parent b645ccd commit fa191de
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,39 @@
# node-red-contrib-js-philips-tv-control

[![node-red-dxp](https://badgen.net/badge/Build%20with/node-red-dxp)](https://www.npmjs.com/package/@keload/node-red-dxp)

[![node-red-contrib-js-philips-tv-control-version](https://badgen.net/npm/v/@keload/node-red-contrib-js-philips-tv-control)](https://www.npmjs.com/package/@keload/node-red-contrib-js-philips-tv-control)


A collection of nodes to control Philips TV with Node-RED, including Ambilight control.

Build on top of [philtv-js](/~https://github.com/clement-berard/philtv-js) (no python, only Javascript), this package provides a set of nodes to control your Philips TV with Node-RED.

<br/>
<p align="center">
<a href="https://www.npmjs.com/package/@keload/node-red-dxp" aria-label="Build with node-red-dxp">
<img src="https://img.shields.io/badge/Build%20with-node--red--dxp-blue?style=for-the-badge" alt="Build with node-red-dxp">
</a>
</p>
<p align="center">
<a href="/~https://github.com/clement-berard/node-red-contrib-js-philips-tv-control/graphs/contributors">
<img src="https://img.shields.io/github/contributors/clement-berard/node-red-contrib-js-philips-tv-control.svg?style=for-the-badge" alt="Contributors">
</a>
<a href="/~https://github.com/clement-berard/node-red-contrib-js-philips-tv-control/network/members">
<img src="https://img.shields.io/github/forks/clement-berard/node-red-contrib-js-philips-tv-control.svg?style=for-the-badge" alt="Forks">
</a>
<a href="/~https://github.com/clement-berard/node-red-contrib-js-philips-tv-control/stargazers">
<img src="https://img.shields.io/github/stars/clement-berard/node-red-contrib-js-philips-tv-control.svg?style=for-the-badge" alt="Stargazers">
</a>
<a href="/~https://github.com/clement-berard/node-red-contrib-js-philips-tv-control/issues">
<img src="https://img.shields.io/github/issues/clement-berard/node-red-contrib-js-philips-tv-control.svg?style=for-the-badge" alt="Issues">
</a>
</p>
<p align="center">
<a aria-label="NPM Version" href="https://www.npmjs.com/package/@keload/node-red-contrib-js-philips-tv-control">
<img alt="NPM Version" src="https://img.shields.io/npm/v/@keload/node-red-contrib-js-philips-tv-control.svg?label=NPM&logo=npm&style=for-the-badge&color=0470FF&logoColor=white">
</a>
<a aria-label="NPM Download Count" href="https://www.npmjs.com/package/@keload/node-red-contrib-js-philips-tv-control">
<img alt="NPM Downloads" src="https://img.shields.io/npm/dt/@keload/node-red-contrib-js-philips-tv-control?label=Downloads&style=for-the-badge&color=67ACF3">
</a>
</p>


## Installation

```bash
Expand Down Expand Up @@ -46,9 +71,7 @@ Send a key to the TV to control it. (Mute, Volume Up, Volume Down, Power, ...)

## Roadmap

- [ ] Improve nodes documentation
- [ ] Add more nodes to manage more features
- [ ] Improve package documentation (Vitepress...)

## Contributing

Expand Down

0 comments on commit fa191de

Please sign in to comment.