add Readme

Author: LunyaaDev

Readme.md

@@ -0,0 +1,28 @@
+# Autodarts Board
+
+A easy-to-use library to interact locally with an [Autodarts](https://autodarts.io) Board.
+
+## ✨ Features
+
+- Connects to Autodarts boards over the local network
+- Listens for real-time dart throw events
+- ability to start and stop the cameras
+- and more...
+
+## 🚀 Example usage
+
+```ts
+import { AutodartsBoard } from 'autodarts-board'
+
+const board = new AutodartsBoard({
+  host: '192.168.0.69',
+})
+
+board.onMessage((msg) => {
+  console.log(msg.data)
+})
+```
+
+## ⚠️ Disclaimer
+
+This library is in no way officially affiliated with or endorsed by Autodarts.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "autodarts-board",
   "version": "0.0.1",
-  "description": "A easy-to-use library to interact locally with Autodarts Board.",
+  "description": "A easy-to-use library to interact locally with an Autodarts Board.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {