Add README

README.md

@@ -0,0 +1,83 @@
+# sliceconv
+
+[![GoDoc](https://godoc.org/github.com/Henry-Sarabia/sliceconv?status.svg)](https://godoc.org/github.com/Henry-Sarabia/sliceconv) [![Build Status](https://travis-ci.com/Henry-Sarabia/sliceconv.svg?branch=master)](https://travis-ci.com/Henry-Sarabia/sliceconv) [![Coverage Status](https://coveralls.io/repos/github/Henry-Sarabia/sliceconv/badge.svg?branch=master)](https://coveralls.io/github/Henry-Sarabia/sliceconv?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/Henry-Sarabia/sliceconv)](https://goreportcard.com/report/github.com/Henry-Sarabia/sliceconv)
+
+Sliceconv implements conversions to and from string representations of primitive types on entire slices.
+This package takes its cue from the Golang standard library's [strconv](https://golang.org/pkg/strconv/). 
+
+## Installation
+
+If you do not have Go installed yet, you can find installation instructions 
+[here](https://golang.org/doc/install).
+
+To pull the most recent version of sliceconv, use `go get`.
+
+```
+go get github.com/Henry-Sarabia/sliceconv
+```
+
+Then import the package into your project.
+
+```go
+import "github.com/Henry-Sarabia/sliceconv"
+```
+
+## Usage
+
+### Strings to Integers
+
+As an example, assume you have a list of test scores as a slice of strings. You mean to find the 
+highest score by passing the list into a `findMax` function. Unfortunately, the function has the signature 
+`findMax([]int) int`. Using sliceconv, simply convert the slice of strings into a slice of ints to
+resolve the issue.
+
+```go
+scores := []string{"98", "85", "100", "76", "92"}
+
+ints, err := sliceconv.Atoi(scores)
+if err != nil {
+	// handle error
+}
+
+max := findMax(ints)
+// 100
+```
+
+Be aware that the `sliceconv.Atoi` function fulfills the same contract as its counterpart 
+`strconv.Atoi`. That is to say, the `Atoi` functions treat the strings as integers in base 10 and
+will return an error if any of the resulting integers cannot fit into the regular `int` type.
+
+### Integers to Strings
+
+This time around, assume you still have a list of test scores but as a slice of ints. You mean to
+format a class report card by passing the list of scores into a `formatReport` function. With a 
+streak of bad luck, the function has the signature `formatReport([]string) string`. With sliceconv,
+you can just convert the slice of ints into a slice of strings to satisfy the requirements.
+
+```go
+scores := []int{98, 85, 100, 76, 92}
+
+str := sliceconv.Itoa(scores)
+report := formatReport(str)
+// student_1: 98, student_2: 85, ..., student_5: 92
+```
+
+Similarly to `sliceconv.Atoi`, the `sliceconv.Itoa` function assumes the integers are in base 10.
+
+## Contributions
+
+If you would like to contribute to this project, please adhere to the following
+guidelines.
+
+* Submit an issue describing the problem.
+* Fork the repo and add your contribution.
+* Add appropriate tests.
+* Run go fmt, go vet, and golint.
+* Prefer idiomatic Go over non-idiomatic code.
+* Follow the basic Go conventions found [here](https://github.com/golang/go/wiki/CodeReviewComments).
+* If in doubt, try to match your code to the current codebase.
+* Create a pull request with a description of your changes.
+
+I'll review pull requests as they come in and merge them if everything checks out.
+
+Any and all contributions are greatly appreciated. Thank you!