Skip to content

Commit 8ca71b2

Browse files
committed
add instructions
1 parent 72eec4a commit 8ca71b2

1 file changed

Lines changed: 61 additions & 1 deletion

File tree

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,64 @@
88
StringUtils for Go! :)
99

1010
StringUtils contains common utility functions available in other programming languages and frameworks
11-
to make it easier for you to manipulate strings, create a parser or a lexer in your project.
11+
to make it easier for you to manipulate strings, create a parser or a lexer in your project.
12+
13+
------
14+
15+
Installation
16+
============
17+
18+
To install stringutils, use `go get`:
19+
20+
go get github.com/maxmousee/stringutils
21+
22+
This will then make the following package(s) available to you:
23+
24+
github.com/maxmousee/stringutils
25+
26+
Import the `maxmousee/stringutils` package into your code using this template:
27+
28+
```go
29+
package main
30+
31+
import (
32+
"fmt"
33+
"github.com/maxmousee/stringutils"
34+
)
35+
36+
func main() {
37+
equalsIgoringCase := stringutils.EqualsIgnoreCase("a", "A")
38+
fmt.Println(equalsIgoringCase)
39+
}
40+
```
41+
42+
------
43+
44+
Staying up to date
45+
==================
46+
47+
To update stringutils to the latest version, use `go get -u github.com/maxmousee/stringutils`.
48+
49+
------
50+
51+
Supported go versions
52+
==================
53+
54+
Support for the last major Go version.
55+
56+
------
57+
58+
Contributing
59+
============
60+
61+
Please feel free to submit issues, fork the repository and send pull requests!
62+
63+
When submitting an issue, please include a complete test function that demonstrates the issue.
64+
65+
66+
------
67+
68+
License
69+
=======
70+
71+
This project is licensed under the terms of the MIT license.

0 commit comments

Comments
 (0)