From 60d4f22e411d5a0e4d80213aaedcf56be6f5ff27 Mon Sep 17 00:00:00 2001 From: Charlie <30303272+charliefoxtwo@users.noreply.github.com> Date: Mon, 8 Jul 2024 20:04:33 -0700 Subject: [PATCH] Update readme --- README.md | 51 +++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 37 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 11d1402..8f691c5 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,50 @@ # DCS BIOS Communicator -[![Nuget](https://img.shields.io/nuget/v/DcsBios.Communicator?style=flat-square)](https://www.nuget.org/packages/DcsBios.Communicator/) -[![.NET 5 CI build](https://github.com/charliefoxtwo/DCS-BIOS-Communicator/actions/workflows/ci-build.yml/badge.svg?branch=develop)](https://github.com/charliefoxtwo/DCS-BIOS-Communicator/actions/workflows/ci-build.yml) -[![GitHub](https://img.shields.io/github/license/charliefoxtwo/DCS-BIOS-Communicator?style=flat-square)](LICENSE) -[![Discord](https://img.shields.io/discord/840762843917582347?style=flat-square)](https://discord.gg/rWAF3AdsKT) - -DCS BIOS Communicator is a .net 5 library for interacting with DCS-BIOS. It parses the raw data bytes provided by DCS-BIOS and will trigger actions when it receives data. - -DCS BIOS Communicator logo - a vector outline of an airplane +[![Nuget](https://img.shields.io/nuget/v/DcsBios.Communicator?style=for-the-badge)](https://www.nuget.org/packages/DcsBios.Communicator/) +[![.NET 8 CI build](https://img.shields.io/github/actions/workflow/status/charliefoxtwo/DCS-BIOS-Communicator/ci-build.yml?style=for-the-badge)](https://github.com/charliefoxtwo/DCS-BIOS-Communicator/actions/workflows/ci-build.yml) +[![GitHub](https://img.shields.io/github/license/charliefoxtwo/DCS-BIOS-Communicator?style=for-the-badge)](LICENSE) +[![Discord](https://img.shields.io/discord/840762843917582347?style=for-the-badge)](https://discord.gg/rWAF3AdsKT) + +
+
+ + DCS BIOS Communicator logo - a vector outline of an airplane + + +

DCS-BIOS Communicator

+ +

+ a .NET library for communicating with DCS-BIOS +
+

+
+ +
+ Table of Contents +
    +
  1. + Features +
  2. +
  3. + Getting Started +
  4. +
  5. Benchmarks
  6. +
  7. Roadmap
  8. +
  9. Acknowledgments
  10. +
+
+ +DCS BIOS Communicator is a .net 8 library for interacting with DCS-BIOS. It parses the raw data bytes provided by DCS-BIOS and will trigger actions when it receives data. ## Features - Parses data from DCS-BIOS - Handles pesky UTF-8 symbols - Might buy you an ice cream sandwich if you're lucky -- Cross platform - +- Cross-platform -## Usage/Examples +## Usage ```c# // create a new UDP client for talking to DCS-BIOS @@ -55,13 +81,10 @@ Job=.NET 8.0 Runtime=.NET 8.0 | | | | | | | TestInt | 1.290 ns | 0.0114 ns | 0.0106 ns | 1.00 | - - ## Roadmap - Unit tests - ## Acknowledgements - [Package icon](https://www.flaticon.com/authors/good-ware)