Skip to content

Commit 9f5ee3b

Browse files
committed
chore: add readme
1 parent cf054b8 commit 9f5ee3b

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Axolotl language files
2+
3+
The language files used by Hypera Development's Axolotl Discord bot.
4+
5+
## What is Axolotl?
6+
7+
Axolotl is the Discord bot used by Hypera Development to run our Discord servers.<br/>
8+
In order to make Axolotl super helpful, we have decided to support multiple locales so that users can easily understand
9+
and interact with Axolotl.
10+
11+
This module (`hypera.dev/axolotl-lang/v2`) contains the translatable language files used by Axolotl to display messages
12+
in Discord.
13+
14+
### Supported languages
15+
16+
The current supported locales are:
17+
18+
- [English, UK (en-GB)](locales/en-GB.toml)
19+
- [English, US (en-US)](locales/en-US.toml)
20+
- [日本語 (ja)](locales/ja.toml)
21+
22+
## Contributing
23+
24+
We welcome all contributions! If you have found a mistake or something that can be improved, please feel free to
25+
contribute! If you would like to contribute to this project, please see our [contributing guide](CONTRIBUTING.md).
26+
27+
We are also looking to translate messages into more languages as well! If you know a language that Axolotl does not
28+
currently support, please contribute translations so that we can reach more people who know your language!
29+
30+
## Contact
31+
32+
You can contact us in our [official Discord server](https://discord.hypera.dev/) (fastest) or emailing us
33+
34+
35+
## Acknowledgements
36+
37+
We are extremely grateful to
38+
the [amazing individuals who have contributed](https://github.com/HyperaDev/axolotl-lang/graphs/contributors)
39+
translations, improvements, fixes and more! Thank you! :D

0 commit comments

Comments
 (0)