Update documentation

linkdotnet · Apr 5, 2022 · 9c383f2 · 9c383f2
1 parent 7932b4d
commit 9c383f2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/docs/site/index.md b/docs/site/index.md
@@ -1,13 +1,13 @@
 [![.NET](https://github.com/linkdotnet/StringBuilder/actions/workflows/dotnet.yml/badge.svg)](https://github.com/linkdotnet/StringBuilder/actions/workflows/dotnet.yml)
 [![Nuget](https://img.shields.io/nuget/dt/LinkDotNet.StringBuilder)](https://www.nuget.org/packages/LinkDotNet.StringBuilder/)
-
 # ValueStringBuilder: A fast and low allocation StringBuilder for .NET
 
 **ValueStringBuilder** aims to be as fast as possible with a minimal amount of allocation memory. This documentation will show case you how to use the `ValueStringBuilder` as well as what are some limitations coming with it. If you have questions or feature requests just head over to the [GitHub](https://github.com/linkdotnet/StringBuilder) repository and file and issue.
 
+The library makes heavily use of `Span<T>`, `stackalloc` and `ArrayPool`s to achieve the low allocations and fast performance.
 
 ## Download
-The package is hosted on nuget.org, so easily add the package reference:
+The package is hosted on [nuget.org]((https://www.nuget.org/packages/LinkDotNet.StringBuilder/)), so easily add the package reference:
 > PM> Install-Package LinkDotNet.StringBuilder
 
 Afterwards you can simply use it. It tries to mimic the API of the `StringBuilder` to a certain extend so for simpler cases you can exchange those two.
@@ -18,14 +18,15 @@ The API is leaning towards the normal `StringBuilder` which is part of the .net
 
 ```csharp
 var stringBuilder = new ValueStringBuilder();
-stringBuilder.AppendLine("Hello");
-stringBuilder.Append("World");
+stringBuilder.AppendLine("Hello World");
+stringBuilder.Append("2+2=");
+stringBuilder.Append(4);
 
 Console.Write(stringBuilder.ToString());
 ```
 
 This will print
 ```
-Hello
-World
+Hello World
+2+2=4
 ```
diff --git a/docs/site/toc.yml b/docs/site/toc.yml
@@ -1,5 +1,5 @@
-- name: Articles
+- name: Documentation
   href: articles/
-- name: Api Documentation
+- name: Api References
   href: api/
   homepage: api/index.md