Skip to content
This repository has been archived by the owner on Sep 25, 2024. It is now read-only.

Commit

Permalink
Merge pull request #44 from LemonyOwO/patch-1
Browse files Browse the repository at this point in the history
Fix typos.
  • Loading branch information
nashiradeer authored Apr 4, 2024
2 parents 21f855d + cdd5c9b commit 1fb9db3
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nashira Deer // Hydrogen

**Warning: Hydrogen still in the alpha development stage.**
**Warning: Hydrogen is still in alpha development stage.**

Open-source Dungeon Master helper with useful features and a music player for your sessions.

Expand All @@ -15,19 +15,19 @@ Manage RPG campaigns and role-play characters inside Discord without downloading

## Donating

Independent if you are using public instance, or it owns instance, consider donating to make Hydrogen development possible. You can donate thought Nashira Deer's [PayPal](https://www.paypal.com/donate/?business=QQGMTC3FQAJF6&no_recurring=0&item_name=Thanks+for+donating+for+me%2C+this+helps+me+a+lot+to+continue+developing+and+maintaining+my+projects.&currency_code=USD) or [GitHub Sponsor](https://github.com/sponsors/nashiradeer).
Whether you are using a public instance or your own, please consider donating to support Hydrogen's development. You can donate thought Nashira Deer's [PayPal](https://www.paypal.com/donate/?business=QQGMTC3FQAJF6&no_recurring=0&item_name=Thanks+for+donating+for+me%2C+this+helps+me+a+lot+to+continue+developing+and+maintaining+my+projects.&currency_code=USD) or [GitHub Sponsor](https://github.com/sponsors/nashiradeer).

## Official Public Instance

If you are interested in a public instance of Hydrogen, you can add our official instance, hosted by [Nashira Deer](https://github.com/nashiradeer), to your Discord's server, [clicking here](https://discord.com/api/oauth2/authorize?client_id=1128087591179268116&permissions=275417975808&scope=bot+applications.commands).

## Building/running

Only the methods listed below is officially supported and tested by Nashira Deer, we don't recommend you using any other alternative to build Hydrogen as Hydrogen isn't developed to support it.
Only the methods listed below are officially supported and tested by Nashira Deer. We don't recommend using any other alternatives to build Hydrogen, as it isn't developed to support them.

### Docker

You can build Hydrogen using `docker build -t hydrogen:latest .` in a terminal with [Docker](https://docker.com) (Podman not supported) installed and running, before the build is completed you will have a ready to use Docker image available with "hydrogen:latest" name.
You can build Hydrogen using `docker build -t hydrogen:latest .` in a terminal with [Docker](https://docker.com) (Podman not supported) installed and running, after the build is completed, you will have a Docker image ready for use, named "hydrogen:latest".

If you don't want to build your own image, you can use our prebuilt image found on [Docker Hub](https://hub.docker.com/r/nashiradeer/hydrogen). To run it, you can see our example using [Docker Compose](compose.yaml).

Expand All @@ -43,7 +43,7 @@ When starting, Hydrogen searches for the config file in `$XDG_CONFIG_HOME/hydrog

### Environment Variables

- HYDROGEN_DISCORD_TOKEN: Sets the token that will be used to access a Discord. (required)
- HYDROGEN_DISCORD_TOKEN: Sets the token that will be used to access Discord. (required)
- HYDROGEN_LAVALINK: Set the list of Lavalink nodes that can be used, read more below. (required)
- HYDROGEN_DEFAULT_LANGUAGE: Sets a new default language to Hydrogen. (optional)
- HYDROGEN_LANGUAGE_PATH: Sets the path where the Hydrogen translation files can be found. (optional)
Expand All @@ -61,4 +61,4 @@ tls = "true" / "enabled" / "on"

## Credits

Hydrogen is a Nashira Deer's project licensed under the [GNU General Public License v3](LICENSE.txt).
Hydrogen is a project by Nashira Deer, licensed under [GNU General Public License v3](LICENSE.txt).

0 comments on commit 1fb9db3

Please sign in to comment.