Skip to content

Update README and always run tests on master #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matrixik merged 2 commits into from
Jul 26, 2021
Merged

Update README and always run tests on master #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77bde10
Always run Go tests on master branch
matrixik Jul 26, 2021
53045a2
Add benchmarking info to README
matrixik Jul 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ on:
branches:
- master
- main
# Only run if there are changes to Go code or related configurations
paths:
- "**.go"
- "go.mod"
- "go.sum"
- "codecov.yml"
pull_request:
# Only run if there are changes to Go code or related configurations
paths:
Expand Down
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
slug
====
# slug

Package `slug` generate slug from unicode string, URL-friendly slugify with
multiple languages support.
Expand Down Expand Up @@ -31,7 +30,7 @@ func main() {

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"
Expand All @@ -42,17 +41,30 @@ func main() {
textSub := slug.Make("water is hot")
fmt.Println(textSub) // Will print: "sand-is-hot"
}

```

### Requests or bugs?

<https://github.com/gosimple/slug/issues>

## Installation
```sh

```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
Expand Down