From 872ce23d5c9ce6625a6dcb15743369cb229c8b66 Mon Sep 17 00:00:00 2001
From: Branden Colen <brandencolen@gmail.com>
Date: Thu, 1 Apr 2021 18:28:22 -0500
Subject: [PATCH] updated docs

---
 README.md       | 28 +++++++++++++++++++++-------
 romannumeral.go |  5 ++---
 2 files changed, 23 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index eb31b47..e94fe4d 100644
--- a/README.md
+++ b/README.md
@@ -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)
 	}
diff --git a/romannumeral.go b/romannumeral.go
index d9fe75a..08a5cfe 100644
--- a/romannumeral.go
+++ b/romannumeral.go
@@ -1,8 +1,7 @@
 // Converts between integers and Roman Numeral strings.
 //
 // Currently only supports Roman Numerals without viniculum (1-3999) and will throw an error for
-// numbers outside of that range.
-//
+// numbers outside of that range. See here for details on viniculum:
 // https://en.wikipedia.org/wiki/Roman_numerals#Large_numbers
 package romannumeral
 
@@ -63,7 +62,7 @@ func intToRoman(input int) string {
 }
 
 // ToInt converts a roman numeral string to an integer. Roman numerals for numbers
-// outside of the range 1 to 3999 will return an error.
+// outside of the range 1 to 3,999 will return an error.
 func ToInt(input string) (int, error) {
 	if input == "" {
 		return 0, nil