Updated README.md

This commit is contained in:
bradley.richins
2020-10-24 10:38:28 -06:00
parent 2bb7ca6ccd
commit 67db2e32ef

View File

@@ -2,8 +2,7 @@
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
NMSlib also translates in game languages to english.
## Installation
@@ -64,7 +63,7 @@ nmslib.CreateBanner("006afa556c30", "NewLennon.png", 0)
### Converting Portal code to Galactic address with P2gc()
This function only takes 1 parameter and returns a string
This function only takes 1 parameter and returns a string and error
* portalcode: 12 char hex string of portal glyphs
@@ -81,7 +80,7 @@ Output:
### Converting Galactic coordinates to Portal codes with Gc2p()
This function only takes 1 parameter and returns a string
This function only takes 1 parameter and returns a string and error
* galacticaddress: 16 char 4 block hex address
@@ -96,21 +95,30 @@ Output:
``006AFA556C30``
### Translate Korvax to English with Korvax2Eng()
## Translate Words
Supported languages
- Korvax
- Gek
- Vy'keen
- Atlas
### Translate Atlas to English with Atl2Eng()
This function takes only 1 parameter and returns a string
* korvaxword: Any known Korvaxen word (ex. eapoluch)
* Word: Any known Atlas word (ex. Paka)
**Example:**
```golang
fmt.Println(Translate{"KIHTYOMOLES"}.Kor2Eng())
fmt.Println(Translate{"Paka"}.Atl2Eng())
```
Output:
``CONTRABAND``
``Awake``
### Translate English to Korvax with Eng2Korvax()
@@ -129,5 +137,24 @@ Output:
``Zelidovoso``
### Language commands
Gek:
- ``Translate{word}.Gek2Eng()``
- ``Translate{word}.Eng2Gek()``
Korvax:
- ``Translate{word}.Kor2Eng()``
- ``Translate{word}.Eng2Kor()``
Vy'keen:
- ``Translate{word}.Vyk2Eng()``
- ``Translate{word}.Eng2Vyk()``
Atlas:
- ``Translate{word}.Atl2Eng()``
- ``Translate{word}.Eng2Atl()``
## License
[MIT](COPYING)