updated docs

This commit is contained in:
Branden Colen
2021-04-01 18:28:22 -05:00
parent ec567ba35d
commit 872ce23d5c
2 changed files with 23 additions and 10 deletions
+21 -7
View File
@@ -2,26 +2,40 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/brandenc40/romannumeral.svg)](https://pkg.go.dev/github.com/brandenc40/romannumeral)
Convert to and from roman numerals in Go.
Quickly and efficiently convert to and from roman numerals in Go.
### Benchmark Results
```sh
goos: darwin
goarch: arm64
pkg: github.com/brandenc40/romannumeral
BenchmarkToRomanNumeral
BenchmarkToRomanNumeral-8 10997846 108.5 ns/op
BenchmarkToInteger
BenchmarkToInteger-8 18861016 62.29 ns/op
```
### Example
```go
package main
package main
import (
"fmt"
"github.com/brandenc40/romannumeral"
rom "github.com/brandenc40/romannumeral"
)
func ExampleToInt() {
integer, err := romannumeral.ToInt("IV")
func ExampleRomanToInt() {
integer, err := rom.ToInt("IV")
if err != nil {
panic(err)
}
fmt.Println(integer == 4)
}
func ExampleFromInt() {
roman, err := romannumeral.FromInt(4)
func ExampleIntToRoman() {
roman, err := rom.FromInt(4)
if err != nil {
panic(err)
}