Skip to content

Commit e8c7556

Browse files
Update README.md
1 parent 4b680dc commit e8c7556

1 file changed

Lines changed: 44 additions & 26 deletions

File tree

README.md

Lines changed: 44 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,37 @@
99
[![NuGet Version](https://img.shields.io/nuget/v/ByteFlow.Net.svg?logo=nuget&cacheSeconds=300)](https://www.nuget.org/packages/ByteFlow.Net)
1010
[![NuGet Downloads](https://img.shields.io/nuget/dt/ByteFlow.Net.svg)](https://www.nuget.org/packages/ByteFlow.Net)
1111
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.txt)
12+
![GitHub Repo stars](https://img.shields.io/github/stars/AndrewClements84/ByteFlow.Net?style=flat&color=2bbc8a)
1213

13-
A lightweight .NET library for converting bytes into **human-readable formats** (KB, MB, GB, etc.) and back again.
14+
A lightweight .NET library for converting bytes into **human-readable
15+
formats** (KB, MB, GB, etc.) and back again.
1416

15-
---
17+
------------------------------------------------------------------------
1618

1719
## ✨ Features
1820

19-
- Convert bytes into human-readable strings (`1234567 → "1.18 MB"`).
20-
- Parse strings back into bytes (`"2.5 GB" → 2684354560`).
21-
- Safe parsing with `TryParseHumanBytes`.
22-
- Zero dependencies, just clean C#.
23-
- Works on .NET Framework (4.6.1+) and all modern .NET versions (Core, 5/6/7/8).
21+
- Convert bytes into human-readable strings (`1234567 → "1.18 MB"`).
22+
- Parse strings back into bytes (`"2.5 GB" → 2684354560`).
23+
- Safe parsing with `TryParseHumanBytes`.
24+
- Zero dependencies, just clean C#.
25+
- Works on .NET Framework (4.6.1+) and all modern .NET versions (Core,
26+
5/6/7/8).
2427

25-
---
28+
------------------------------------------------------------------------
2629

2730
## 📦 Installation
2831

2932
Install from [NuGet](https://www.nuget.org/packages/ByteFlow.Net):
3033

31-
```sh
34+
``` sh
3235
dotnet add package ByteFlow.Net
3336
```
3437

35-
---
38+
------------------------------------------------------------------------
3639

3740
## 🚀 Usage
3841

39-
```csharp
42+
``` csharp
4043
using ByteFlowNet;
4144

4245
// Convert bytes to human-readable string
@@ -55,45 +58,60 @@ if ("10 MB".TryParseHumanBytes(out var val))
5558
}
5659
```
5760

58-
---
61+
------------------------------------------------------------------------
5962

6063
## 🧪 Unit Tests
6164

62-
Unit tests are included under the `tests/ByteFlowNet.Tests` project using **xUnit**.
65+
Unit tests are included under the `tests/ByteFlowNet.Tests` project
66+
using **xUnit**.
6367

6468
Run them with:
6569

66-
```sh
70+
``` sh
6771
dotnet test
6872
```
6973

70-
---
74+
------------------------------------------------------------------------
7175

7276
## 📊 Code Coverage
7377

74-
Code coverage reports are automatically uploaded to [Codecov](https://app.codecov.io/gh/AndrewClements84/ByteFlow.Net).
78+
Code coverage reports are automatically uploaded to
79+
[Codecov](https://app.codecov.io/gh/AndrewClements84/ByteFlow.Net).\
7580
Current coverage: **100%**
7681

77-
---
82+
------------------------------------------------------------------------
7883

7984
## 🔮 Roadmap
8085

8186
Planned features for upcoming releases:
8287

83-
- [ ] Support for both **IEC (binary: KiB, MiB)** and **SI (decimal: KB, MB)** unit standards
84-
- [ ] Culture-aware parsing (e.g., commas vs dots for decimals)
85-
- [ ] Customizable suffix sets (allowing non-standard units)
86-
- [ ] Performance benchmarking and optimizations for very large inputs
87-
- [ ] Additional helpers for formatting with alignment/padding
88+
- [ ] Support for both **IEC (binary: KiB, MiB)** and **SI (decimal:
89+
KB, MB)** unit standards\
90+
- [ ] Culture-aware parsing (e.g., commas vs dots for decimals)\
91+
- [ ] Customizable suffix sets (allowing non-standard units)\
92+
- [ ] Performance benchmarking and optimizations for very large
93+
inputs\
94+
- [ ] Additional helpers for formatting with alignment/padding
8895

89-
---
96+
------------------------------------------------------------------------
9097

9198
## 🤝 Contributing
9299

93-
Contributions, issues, and feature requests are welcome!
94-
Feel free to open a [discussion](https://github.com/AndrewClements84/ByteFlow.Net/discussions) or a [pull request](https://github.com/AndrewClements84/ByteFlow.Net/pulls).
100+
Contributions, issues, and feature requests are welcome!\
101+
Feel free to open a
102+
[discussion](https://github.com/AndrewClements84/ByteFlow.Net/discussions)
103+
or a [pull
104+
request](https://github.com/AndrewClements84/ByteFlow.Net/pulls).
105+
106+
------------------------------------------------------------------------
107+
108+
## ⭐ Support
109+
110+
If you find **ByteFlow.Net** useful, please consider giving it a star on
111+
GitHub --- it helps others discover the project and shows your support.
112+
113+
------------------------------------------------------------------------
95114

96-
---
97115

98116
## 📄 License
99117

0 commit comments

Comments
 (0)