Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 61 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,67 @@

[![Build](https://github.com/SmartHomeOS/HomeKitDotNet/actions/workflows/dotnet.yml/badge.svg)](https://github.com/SmartHomeOS/HomeKitDotNet/actions/workflows/dotnet.yml)
[![Version](https://img.shields.io/nuget/v/HomeKitDotNet.svg)](https://www.nuget.org/packages/HomeKitDotNet)
# <img src="HomeKitDotNet/logo.png" height="50"> HomeKitDotNet
* A 100% native implementation of a HomeKit Controller in dotnet
* Works on all architectures and operating systems without dependencies
* Implements all 243 characteristics and 71 services
[![NuGet Version](https://img.shields.io/nuget/v/HomeKitDotNet.svg)](https://www.nuget.org/packages/HomeKitDotNet)

#### Working:
* Pairing
* Connection Management
* Reading and writing characteristics
* Eventing
# <img src="HomeKitDotNet/logo.png" height="50"> HomeKitDotNet

#### TODO:
* More Examples
**HomeKitDotNet** is a 100% native implementation of a **HomeKit Controller** in .NET.

#### Other Projects:
* Check out my other projects for [ZWave](https://github.com/SmartHomeOS/ZWaveDotNet) and [Matter](https://github.com/SmartHomeOS/MatterDotNet).
- ✅ Cross-platform support — works on **Windows, Linux, macOS, ARM (e.g. Raspberry Pi)** with no external dependencies
- ✅ Fully implements all **243 HomeKit characteristics** and **71 services**
- ✅ Designed for **automations, testing, or interfacing with HomeKit accessories** from your own applications

Support is always appreciated:<br/><a href="https://www.buymeacoffee.com/jdomnitz" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Pizza" style="height: 60px !important;width: 217px !important;" ></a>
---

Note:
This library is not affiliated with or endorsed by Apple
## ✨ Features

- 🔐 **Pairing** with HomeKit accessories
- 🔄 **Connection management** and secure communication
- 📖 **Read and write** characteristics
- 🔔 **Eventing** — receive real-time updates from accessories

---

## 📦 Installation

Install via NuGet:

```bash
dotnet add package HomeKitDotNet
```

---

## 🚀 Usage

Examples coming soon!
In the meantime, check out the `Examples/` folder (or contribute your own via PRs 👇).

---

## 🛠️ TODO

- [ ] Add more usage examples
- [ ] Add advanced eventing/automation samples

---

## 🌍 Related Projects

Explore my other smart home projects:

- 🔗 [ZWaveDotNet](https://github.com/SmartHomeOS/ZWaveDotNet) — Native Z-Wave implementation in .NET
- 🌐 [MatterDotNet](https://github.com/SmartHomeOS/MatterDotNet) — Matter protocol implementation in .NET

---

## ☕ Support

If you find this library useful, consider buying me a coffee (or pizza!):

[![Buy Me a Pizza](https://cdn.buymeacoffee.com/buttons/v2/default-red.png)](https://www.buymeacoffee.com/jdomnitz)

---

> **Note:** This project is not affiliated with or endorsed by Apple Inc.
> **HomeKit** is a trademark of Apple Inc., registered in the U.S. and other countries.
```