Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cyradin committed Jan 21, 2023
1 parent 2440f80 commit eb7ca3c
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

Set of different phonetic encoders' implementations.

Now consists of:
Provided encoders:
* [Beider-Morse encoder](#beider-morse-encoder) - BMPM implementation. It's a Go port of [the original PHP library](https://stevemorse.org/phoneticinfo.htm)
* [Caverphone2](#caverphone2-encoder) - implementation of [Caverphone 2.0 algorithm](https://en.wikipedia.org/wiki/Caverphone#Caverphone_2.0)


## Installion
Expand Down Expand Up @@ -91,3 +92,23 @@ func main() {
// prints: [uranzi uranz uranS uranzi uranz uranhi uranh]
}
```

### Caverphone2 encoder
Code example:

```go
package main

import (
"fmt"

"github.com/f1monkey/phonetic/caverphone2"
)

func main() {
e := caverphone2.NewEncoder()
result := e.Encode("orange")
fmt.Println(result)
// prints: ARNK111111
}
```

0 comments on commit eb7ca3c

Please sign in to comment.