commit d140f4ad6e664cf3c1199437e8a27dd6e8e7b569 Author: Charles Iliya Krempeaux Date: Mon Nov 27 06:46:40 2023 -0800 initial commits diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a3bf392 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2023 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..226639e --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# go-eol + +Package **eol** implements tools for working with end-of-line, for the Go programming language. + +The end-of-line sequences it supports is: + +* "\n" // line-feed +* "\r" // carriage-return +* "\r\n" // carriage-return, line-feed +* "\u0085" // new-line +* "\u2028" // line-separator + +## Documention + +Online documentation, which includes examples, can be found at: http://godoc.org/sourcecode.social/reiver/go-eol + +[![GoDoc](https://godoc.org/sourcecode.social/reiver/go-eol?status.svg)](https://godoc.org/sourcecode.social/reiver/go-eol) + +## Example + +Here is an example: +```golang + +import "sourcecode.social/reiver/go-eol" + +// ... + +eodofline, size, err := eol.ReadEOL(runereader) +if nil != err { + return err +} +``` + +## Import + +To import package **eol** use `import` code like the follownig: +``` +import "sourcecode.social/reiver/go-eol" +``` + +## Installation + +To install package **eol** do the following: +``` +GOPROXY=direct go get https://sourcecode.social/reiver/go-eol +``` + +## Author + +Package **eol** was written by [Charles Iliya Krempeaux](http://changelog.ca)