commit bd5fb81906d79a3b8c714868773df0974c298b59 Author: Charles Iliya Krempeaux Date: Wed Nov 1 08:17:43 2023 -0700 initial commits diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..87459a0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2017 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..7b016f9 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# go-exp + +Package **exp** implements an **expiring** **optional-type** with a **time-out**, for the Go programming language. + +In other programming languages, an **optional-type** might be know as: a **option-type**, or a **maybe-type**. + +## Documention + +Online documentation, which includes examples, can be found at: http://godoc.org/sourcecode.social/reiver/go-exp + +[![GoDoc](https://godoc.org/sourcecode.social/reiver/go-exp?status.svg)](https://godoc.org/sourcecode.social/reiver/go-exp) + +## Import + +To import package **exp** use `import` code like the follownig: +``` +import "sourcecode.social/reiver/go-exp" +``` + +## Installation + +To install package **exp** do the following: +``` +GOPROXY=direct go get https://sourcecode.social/reiver/go-exp +``` + +## Author + +Package **exp** was written by [Charles Iliya Krempeaux](http://changelog.ca)