Skip to content

Commit a9260ad

Browse files
committed
Improve README documentation
1 parent 6659ebd commit a9260ad

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
**Tiny, fast `ref struct` string builder.**
99
Backed by `ArrayPool<char>`. Low allocations. Short-lived use.
1010

11-
## Install
11+
## Installation
1212

1313
```bash
1414
dotnet add package Soenneker.Utils.PooledStringBuilders
@@ -35,7 +35,7 @@ string s = sb.ToString(); // returns string + returns buffer
3535
* `new PooledStringBuilder(int capacity = 128)`
3636
* `Append(char)`, `Append(string?)`, `Append(ReadOnlySpan<char>)`
3737
* `Append<T>(T value, ReadOnlySpan<char> fmt = default, IFormatProvider? prov = null)` where `T : ISpanFormattable`
38-
* `AppendSpan(int length)` ? write directly into the buffer
38+
* `AppendSpan(int length)` - write directly into the buffer
3939
* `AppendLine()`, `AppendSeparatorIfNotEmpty(char)`
4040
* `Length`, `Capacity`, `Clear()`
4141
* `ToString()` (keep using; you must `Dispose()` later)
@@ -44,7 +44,7 @@ string s = sb.ToString(); // returns string + returns buffer
4444

4545
## Notes
4646

47-
* **`ref struct`** ? stack-only. Don’t capture, box, store in fields, or cross `await`.
47+
* **`ref struct`** - stack-only. Don't capture, box, store in fields, or cross `await`.
4848
* **Dispose when done.** `using` should be used, or there is `ToStringAndDispose()`. Don't use both.
4949
* **Handling secrets?** Use `ToStringAndDispose(clear: true)` to zero the array before returning to the pool.
5050
* Not thread-safe. Keep it short-lived and single-scope.

0 commit comments

Comments
 (0)