Skip to content

Commit 0cbeb15

Browse files
committed
Updating readme
1 parent 8ca7432 commit 0cbeb15

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,49 @@
1-
# WLED.NET
1+
# WLED.NET [![Continuous Integration Workflow](https://github.com/kevbite/WLED.NET/actions/workflows/continuous-integration-workflow.yml/badge.svg)](https://github.com/kevbite/WLED.NET/actions/workflows/continuous-integration-workflow.yml) [![install from nuget](http://img.shields.io/nuget/v/WLED.svg?style=flat-square)](https://www.nuget.org/packages/WLED) [![downloads](http://img.shields.io/nuget/dt/WLED.svg?style=flat-square)](https://www.nuget.org/packages/Kevsoft.WLED)
2+
23
A .NET Wrapper around the [WLED](https://github.com/Aircoookie/WLED) [JSON API](https://github.com/Aircoookie/WLED/wiki/JSON-API).
4+
5+
## Getting Started
6+
7+
### Installing Package
8+
9+
**WLED.NET** can be installed directly via the package manager console by executing the following commandlet:
10+
11+
```powershell
12+
Install-Package WLED
13+
```
14+
15+
alternative you can use the dotnet CLI.
16+
17+
```bash
18+
dotnet add package WLED
19+
```
20+
21+
## Usage
22+
23+
### Getting data from the WLED device
24+
25+
```csharp
26+
var client = new WLedClient("http://office-computer-wled/");
27+
28+
var data = await client.Get();
29+
```
30+
31+
### Post data to the WLED device
32+
33+
Turn on the device on
34+
35+
```csharp
36+
var client = new WLedClient("http://office-computer-wled/");
37+
await client.Post(new StateRequest { On = true });
38+
```
39+
## Samples
40+
41+
The [samples](samples/) folder containers examples of how you could use the WLED.NET Library.
42+
43+
## Contributing
44+
45+
1. Issue
46+
1. Fork
47+
1. Hack!
48+
1. Pull Request
49+

0 commit comments

Comments
 (0)