Update README.md
This commit is contained in:
@@ -1,2 +1,43 @@
|
||||
# blueprint-translations
|
||||
Translation files for the Translations Addon for Pterodactyl Panel (Utilizes Blueprint Framework)
|
||||
|
||||
Translation files for the Translations Addon for Pterodactyl Panel (Utilizes Blueprint Framework).
|
||||
|
||||
## Contributing Translations
|
||||
|
||||
We welcome contributions to help expand the language support for the Translations Addon! If you'd like to submit a translation, please follow the steps below:
|
||||
|
||||
### How to Submit a Translation
|
||||
1. **Fork the Repository**: Click the "Fork" button on the top right of this repository to create your own copy.
|
||||
2. **Add Your Translation**:
|
||||
- Navigate to the `translations/` directory.
|
||||
- If your language is not yet available, create a new folder following the [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g., `fr` for French, `de` for German).
|
||||
- Add or edit the JSON translation file following the format of existing translations.
|
||||
3. **Submit a Pull Request**: Once you've added or updated a translation, create a pull request (PR) with a short description of the changes.
|
||||
|
||||
### Alternative Submission Method
|
||||
If you are not comfortable using GitHub, you can submit translation files via:
|
||||
- Our Discord server (if applicable)
|
||||
- Emailing the files to [your contact email]
|
||||
|
||||
## Translation File Format
|
||||
Example of translation file format (example for English `en.json`):
|
||||
```json
|
||||
{
|
||||
"general": {
|
||||
"welcome": "Welcome",
|
||||
"dashboard": "Dashboard"
|
||||
},
|
||||
"errors": {
|
||||
"not_found": "Page not found",
|
||||
"unauthorized": "You are not authorized to view this page"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Please keep the structure consistent with existing translations.
|
||||
|
||||
## License
|
||||
This project is open-source and follows the MIT License. By submitting translations, you agree to contribute under the same license.
|
||||
|
||||
Thank you for helping improve the Translations Addon!
|
||||
|
||||
|
||||
Reference in New Issue
Block a user