-
Notifications
You must be signed in to change notification settings - Fork 108
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve benchmaring info in README (#60)
- Loading branch information
Showing
1 changed file
with
74 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,74 @@ | ||
| # slug | ||
|
|
||
| Package `slug` generate slug from unicode string, URL-friendly slugify with | ||
| multiple languages support. | ||
|
|
||
| [](https://pkg.go.dev/github.com/gosimple/slug) | ||
| [](https://github.com/gosimple/slug/actions/workflows/tests.yml) | ||
| [](https://codecov.io/gh/gosimple/slug) | ||
| [](https://github.com/gosimple/slug/releases) | ||
|
|
||
| ## Example | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "github.com/gosimple/slug" | ||
| ) | ||
|
|
||
| func main() { | ||
| text := slug.Make("Hellö Wörld хелло ворлд") | ||
| fmt.Println(text) // Will print: "hello-world-khello-vorld" | ||
|
|
||
| someText := slug.Make("影師") | ||
| fmt.Println(someText) // Will print: "ying-shi" | ||
|
|
||
| enText := slug.MakeLang("This & that", "en") | ||
| fmt.Println(enText) // Will print: "this-and-that" | ||
|
|
||
| deText := slug.MakeLang("Diese & Dass", "de") | ||
| fmt.Println(deText) // Will print: "diese-und-dass" | ||
|
|
||
| slug.Lowercase = false // Keep uppercase characters | ||
| deUppercaseText := slug.MakeLang("Diese & Dass", "de") | ||
| fmt.Println(deUppercaseText) // Will print: "Diese-und-Dass" | ||
|
|
||
| slug.CustomSub = map[string]string{ | ||
| "water": "sand", | ||
| } | ||
| textSub := slug.Make("water is hot") | ||
| fmt.Println(textSub) // Will print: "sand-is-hot" | ||
| } | ||
| ``` | ||
|
|
||
| ### Requests or bugs? | ||
|
|
||
| <https://github.com/gosimple/slug/issues> | ||
|
|
||
| ## Installation | ||
|
|
||
| ```shell | ||
| go get -u github.com/gosimple/slug | ||
| ``` | ||
|
|
||
| ## Benchmarking | ||
|
|
||
| ```shell | ||
| go get -u golang.org/x/perf/cmd/benchstat | ||
|
|
||
| go test -run=NONE -bench=. ./... > old.txt | ||
| # make changes | ||
| go test -run=NONE -bench=. ./... > new.txt | ||
|
|
||
| benchstat old.txt new.txt | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| The source files are distributed under the | ||
| [Mozilla Public License, version 2.0](http://mozilla.org/MPL/2.0/), | ||
| unless otherwise noted. | ||
| Please read the [FAQ](http://www.mozilla.org/MPL/2.0/FAQ.html) | ||
| if you have further questions regarding the license. | ||
| # slug | ||
|
|
||
| Package `slug` generate slug from unicode string, URL-friendly slugify with | ||
| multiple languages support. | ||
|
|
||
| [](https://pkg.go.dev/github.com/gosimple/slug) | ||
| [](https://github.com/gosimple/slug/actions/workflows/tests.yml) | ||
| [](https://codecov.io/gh/gosimple/slug) | ||
| [](https://github.com/gosimple/slug/releases) | ||
|
|
||
| ## Example | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "github.com/gosimple/slug" | ||
| ) | ||
|
|
||
| func main() { | ||
| text := slug.Make("Hellö Wörld хелло ворлд") | ||
| fmt.Println(text) // Will print: "hello-world-khello-vorld" | ||
|
|
||
| someText := slug.Make("影師") | ||
| fmt.Println(someText) // Will print: "ying-shi" | ||
|
|
||
| enText := slug.MakeLang("This & that", "en") | ||
| fmt.Println(enText) // Will print: "this-and-that" | ||
|
|
||
| deText := slug.MakeLang("Diese & Dass", "de") | ||
| fmt.Println(deText) // Will print: "diese-und-dass" | ||
|
|
||
| slug.Lowercase = false // Keep uppercase characters | ||
| deUppercaseText := slug.MakeLang("Diese & Dass", "de") | ||
| fmt.Println(deUppercaseText) // Will print: "Diese-und-Dass" | ||
|
|
||
| slug.CustomSub = map[string]string{ | ||
| "water": "sand", | ||
| } | ||
| textSub := slug.Make("water is hot") | ||
| fmt.Println(textSub) // Will print: "sand-is-hot" | ||
| } | ||
| ``` | ||
|
|
||
| ### Requests or bugs? | ||
|
|
||
| <https://github.com/gosimple/slug/issues> | ||
|
|
||
| ## Installation | ||
|
|
||
| ```shell | ||
| go get -u github.com/gosimple/slug | ||
| ``` | ||
|
|
||
| ## Benchmarking | ||
|
|
||
| ```shell | ||
| go test -run=NONE -bench=. -benchmem -count=6 ./... > old.txt | ||
| # make changes | ||
| go test -run=NONE -bench=. -benchmem -count=6 ./... > new.txt | ||
|
|
||
| go install golang.org/x/perf/cmd/benchstat@latest | ||
|
|
||
| benchstat old.txt new.txt | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| The source files are distributed under the | ||
| [Mozilla Public License, version 2.0](http://mozilla.org/MPL/2.0/), | ||
| unless otherwise noted. | ||
| Please read the [FAQ](http://www.mozilla.org/MPL/2.0/FAQ.html) | ||
| if you have further questions regarding the license. |