Files
nmslib/README.md
bradley.richins 1cb2bac407 Added README.md
2020-10-19 13:00:48 -06:00

43 lines
873 B
Markdown

# NMSlib
NMSlib is a GoLang package for dealing with converting Galactic coordinates to Portal codes and vice versa.
NMSlib also translates known Korvax words to English and back.
- Gek, Vykeen, etc will be added in the future
## Installation
To install this module use `go get`
```bash
go get -u gitlab.com/bradley.richins/nmslib
```
## Usage
```golang
package main
import (
"fmt"
"gitlab.com/bradley.richins/nmslib"
)
func main() {
portalcode := "006afa556c30"
tstvar, err := nmslib.P2gc(portalcode)
if err != nil {
panic(err)
}
fmt.Printf("Input: \t%s\nExpecting: \t042F:0079:0D55:006A\nHave: \t%s\n", portalcode, tstvar)
nmslib.CreateBanner(portalcode, "NewLennon.png", 0)
fmt.Println(nmslib.Korvax2Eng("eapoluch"))
fmt.Println(nmslib.Eng2Korvax("emergency"))
}
```
## License
[MIT](https://choosealicense.com/licenses/mit/)