Skip to content

Commit 53f06f7

Browse files
committed
Added better Readme
1 parent 65b4222 commit 53f06f7

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,32 @@
1+
[![Go](https://github.com/linkdotnet/golang-stringbuilder/actions/workflows/go.yml/badge.svg)](https://github.com/linkdotnet/golang-stringbuilder/actions/workflows/go.yml)
2+
[![Go Report card](https://img.shields.io/badge/go%20report-A+-brightgreen.svg?style=flat)](https://img.shields.io/badge/go%20report-A+-brightgreen.svg?style=flat)
3+
[![GoDoc](https://pkg.go.dev/badge/github.com/linkdotnet/golang-stringbuilder?status.svg)](https://pkg.go.dev/github.com/linkdotnet/golang-stringbuilder?tab=doc)
4+
15
# golang-stringbuilder
26
A string builder that has similar capabilities as the one from C#. The goal is to have a straightforward API that lets you work with strings easily.
37

48
## Install
59

610
To install the package, call:
711
```bash
8-
go get -u github.com/linkdotnet/golang-stringbuilder
12+
go get -u github.com/linkdotnet/golang-stringbuilder
913
```
1014

11-
## Usage
15+
Next import the package:
1216
```golang
13-
package sample
17+
import ( "github.com/linkdotnet/golang-stringbuilder" )
18+
```
1419

15-
import (
16-
"fmt"
20+
## Quickstart
1721

18-
Text "github.com/linkdotnet/golang-stringbuilder"
19-
)
22+
The API is derived from the C# `StringBuilder`. You can easily append strings or single runes.
2023

24+
```golang
2125
func main() {
2226
sb := Text.StringBuilder{}
2327
sb.Append("Hello")
2428
sb.Append(" ")
2529
sb.Append("World")
2630
fmt.Println(sb.ToString())
2731
}
28-
2932
```

0 commit comments

Comments
 (0)