From c8e6915895794b766499cf092f14b49ae68c9ecd Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Wed, 1 Mar 2023 09:45:05 -0800 Subject: [PATCH] initial commits --- LICENSE | 19 +++++++++++++++++++ README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 LICENSE create mode 100644 README.md 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..0bb187a --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# go-ord + +Package **ord** provides tools for turning numbers into their human-friendly ordinal representation. + +For example: + +| Number | (English) Ordinal | +|--------|-------------------| +| 1 | 1st | +| 2 | 2nd | +| 3 | 3rd | +| 4 | 4th | +| 5 | 5th | +| ... | ... | +| 20 | 20th | +| 21 | 21st | +| 22 | 22nd | +| 23 | 23rd | +| 24 | 24th | +| 25 | 25th | +| 26 | 26th | +| 27 | 27th | +| ... | ... | + +## Documention + +Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-ord + +[![GoDoc](https://godoc.org/github.com/reiver/go-ord?status.svg)](https://godoc.org/github.com/reiver/go-ord) + +## Example: + +```go +import "github.com/reiver/go-ord/en" + +// ... + +var n int64 = 123 + +fmt.Printf("You are the %s person in line.", orden.FormatInt64(n)) + +// Output: +// You are the 123rd person in line. +```