Skip to content

Commit 74e3cd3

Browse files
committed
Grammar check
1 parent 9372387 commit 74e3cd3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A fast and low allocation StringBuilder for .NET.
1010
Install the package:
1111
> PM> Install-Package LinkDotNet.StringBuilder
1212
13-
Afterwards use the package as follow:
13+
Afterward, use the package as follow:
1414
```csharp
1515
using LinkDotNet.StringBuilder; // Namespace of the package
1616
@@ -30,13 +30,13 @@ _ = ValueStringBuilder.Concat("Hello", 1, 2, 3, "!"); // "Hello123!"
3030

3131
## What does it solve?
3232
The dotnet version of the `StringBuilder` is an all-purpose version that normally fits a wide variety of needs.
33-
But sometimes low allocation is key. Therefore I created the `ValueStringBuilder`. It is not a class but a `ref struct` that tries to do as less allocations as possible.
33+
But sometimes, low allocation is key. Therefore I created the `ValueStringBuilder`. It is not a class but a `ref struct` that tries to allocate as little as possible.
3434
If you want to know how the `ValueStringBuilder` works and why it uses allocations and is even faster, check out [this](https://steven-giesel.com/blogPost/4cada9a7-c462-4133-ad7f-e8b671987896) blog post.
3535
The blog goes into a bit more in detail about how it works with a simplistic version of the `ValueStringBuilder`.
3636

3737
## What it doesn't solve!
3838
The library is not meant as a general replacement for the `StringBuilder` shipped with the .net framework itself. You can head over to the documentation and read about the ["Known limitations"](https://linkdotnet.github.io/StringBuilder/articles/known_limitations.html).
39-
The library works best for a small to medium amount of strings (not multiple 100'000 characters, even though it can be still faster and uses fewer allocations). At any time you can convert the `ValueStringBuilder` to a "normal" `StringBuilder` and vice versa.
39+
The library works best for a small to medium amount of strings (not multiple 100'000 characters, even though it can be still faster and uses fewer allocations). At any time, you can convert the `ValueStringBuilder` to a "normal" `StringBuilder` and vice versa.
4040

4141
The normal use case is to add concatenate strings in a hot path where the goal is to put as minimal pressure on the GC as possible.
4242

@@ -45,7 +45,7 @@ More detailed documentation can be found [here](https://linkdotnet.github.io/Str
4545

4646
## Benchmark
4747

48-
The following table gives you a small comparison between the `StringBuilder` which is part of .NET, [`ZString`](https://github.com/Cysharp/ZString) and the `ValueStringBuilder`:
48+
The following table gives you a small comparison between the `StringBuilder` which is part of .NET, [`ZString`](https://github.com/Cysharp/ZString) and, the `ValueStringBuilder`:
4949

5050
```no-class
5151
BenchmarkDotNet=v0.13.2, OS=macOS Monterey 12.6.1 (21G217) [Darwin 21.6.0]

0 commit comments

Comments
 (0)