From 7bd94cda23a0a0ed8d97fb16ae057459990a36e4 Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Sun, 1 Jul 2018 23:04:04 -0700 Subject: [PATCH] initial commit --- LICENSE | 19 +++++++++++++++++++ README.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4d16580 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2018 Charles Iliya Krempeaux :: http://changelog.ca/ + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b89016 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# go-utf8s + +Package **utf8s** provides tools provides tools for working with Unicode encoded as UTF-8, for the Go programming language. + + +## Documention + +Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-utf8s + +[![GoDoc](https://godoc.org/github.com/reiver/go-utf8s?status.svg)](https://godoc.org/github.com/reiver/go-utf8s) + + +## Example + +```go +var reader io.Reader + +// ... + +r, n, err := utf8s.ReadRune(reader) +``` + +```go +var writer io.Writer + +// ... + +var r rune + +// ... + +n, err := utf8s.WriteRune(w, r) +```