Skip to content

Commit 9457dba

Browse files
committed
chore: Slightly nicer readme
1 parent 95878b1 commit 9457dba

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

.github/workflows/test_and_publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will build a .NET project
22
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
33

4-
name: .NET
4+
name: test and publish
55

66
on:
77
push:

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
1+
<div align="center">
2+
13
# Darp.BinaryObjects
24

3-
[![.NET](https://github.com/rosslight/Darp.BinaryObjects/actions/workflows/test_and_publish.yml/badge.svg)](https://github.com/rosslight/Darp.BinaryObjects/actions/workflows/test_and_publish.yml)
45
[![NuGet](https://img.shields.io/nuget/v/Darp.BinaryObjects.svg)](https://www.nuget.org/packages/Darp.BinaryObjects)
56
[![Downloads](https://img.shields.io/nuget/dt/Darp.BinaryObjects)](https://www.nuget.org/packages/Darp.BinaryObjects)
6-
![License](https://img.shields.io/badge/license-Apache%202.0-blue)
77

8-
A source generator to generate TryRead/Write Little/BigEndian methods for struct/class definitions.
8+
![Dotnet Version](https://img.shields.io/badge/dotnet-net8.0%20%7C%20net9.0-blue)
9+
![Language Version](https://img.shields.io/badge/c%23-11-blue)
10+
11+
[![Tests](https://github.com/rosslight/Darp.BinaryObjects/actions/workflows/test_and_publish.yml/badge.svg)](https://github.com/rosslight/Darp.BinaryObjects/actions/workflows/test_and_publish.yml)
12+
![License](https://img.shields.io/github/license/rosslight/Darp.BinaryObjects)
13+
14+
### A source generator to generate TryRead/Write Little/BigEndian methods for struct/class definitions.
915

1016
> [!IMPORTANT]
1117
> This package is under heavy development. Anything is subject to change.
1218
19+
</div>
1320
You should use the source generation when you want:
1421

1522
- Serialization to a buffer of bytes
1623
- Deserialization from a buffer already completely received
1724
- Endianness during serialization
1825
- Common interfaces for serialization are required which allow to implement more complex scenarios by hand without the generator
1926
- Usage of something like BinaryPrimitives but for more complex types
27+
- Can work with a minimum c# LanguageVersion of 11 and net8.0 / net9.0
2028

2129
If these requirements do not meet your expectations, check out those other wonderful projects
2230

0 commit comments

Comments
 (0)