Skip to content

Commit

Permalink
Release preperation
Browse files Browse the repository at this point in the history
  • Loading branch information
linkdotnet committed Apr 4, 2022
1 parent cb1e20f commit fe84bd9
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# StringBuilder

[![.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)

A fast and low allocation StringBuilder for .NET.

Expand Down
9 changes: 8 additions & 1 deletion docs/site/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
[![.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)

# 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.

## Example

## Download
The package is hosted on nuget.org, so easily add the package reference:
> PM> Install-Package LinkDotNet.StringBuilder

## Example usage
The API is leaning towards the normal `StringBuilder` which is part of the .net framework itself. The main key difference is, that the `ValueStringBuilder` does **not** use the fluent notation of its "big brother".

```csharp
Expand Down
22 changes: 22 additions & 0 deletions src/LinkDotNet.StringBuilder/LinkDotNet.StringBuilder.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,28 @@
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Version>0.9.0</Version>
<Authors>Steven Giesel</Authors>
<Company>Steven Giesel</Company>
<Title>ValueStringBuilder</Title>
<Description>A fast and low allocation StringBuilder for .NET.</Description>
<PackageProjectUrl>https://github.com/linkdotnet/StringBuilder</PackageProjectUrl>
<RepositoryUrl>https://github.com/linkdotnet/StringBuilder</RepositoryUrl>
<PackageTags>string,stringbuilder,csharp,dotnet</PackageTags>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageIcon>logo.png</PackageIcon>
</PropertyGroup>

<ItemGroup>
<None Include="..\..\logo.png">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\..\README.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>

</Project>

0 comments on commit fe84bd9

Please sign in to comment.