Skip to content

Commit 571f160

Browse files
committed
Fixed readme
1 parent 3586fd9 commit 571f160

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ stringBuilder.AppendLine("Hello World");
2020
string result = stringBuilder.ToString();
2121
```
2222

23-
There are also smaller helper functions, which enables you to use `ValueStringBuilder` without any instance:
23+
There are also smaller helper functions, which enable you to use `ValueStringBuilder` without any instance:
2424
```csharp
2525
using LinkDotNet.StringBuilder;
2626

@@ -29,19 +29,19 @@ _ = ValueStringBuilder.Concat("Hello", 1, 2, 3, "!"); // "Hello123!"
2929
```
3030

3131
## What does it solve?
32-
The dotnet version of the `StringBuilder` is a all purpose version which 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` which tries to do as less allocations as possible.
34-
If you want to know how the `ValueStringBuilder` works and why it uses allocations and is even faster, checkout [this](https://steven-giesel.com/blogPost/4cada9a7-c462-4133-ad7f-e8b671987896) blog post.
35-
The blog goes a bit more in detail how it works with a simplistic version of the `ValueStringBuilder`.
32+
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.
34+
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.
35+
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 less allocations). At anytime 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

41-
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.
41+
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

4343
## Documentation
44-
A more detailed documentation can be found [here](https://linkdotnet.github.io/StringBuilder/). It is really important to understand how the `ValueStringBuilder` works so that you not run into weird situations where performance / allocations can even rise.
44+
More detailed documentation can be found [here](https://linkdotnet.github.io/StringBuilder/). It is really important to understand how the `ValueStringBuilder` works so that you did not run into weird situations where performance/allocations can even rise.
4545

4646
## Benchmark
4747

@@ -77,4 +77,4 @@ Another benchmark shows that this `ValueStringBuilder` uses less memory when it
7777
7878
```
7979

80-
Checkout the [Benchmark](tests/LinkDotNet.StringBuilder.Benchmarks) for more detailed comparison and setup.
80+
Checkout the [Benchmark](tests/LinkDotNet.StringBuilder.Benchmarks) for a more detailed comparison and setup.

0 commit comments

Comments
 (0)