Skip to content

Commit

Permalink
docs: make it clear that Minecord ships with all first-party modules
Browse files Browse the repository at this point in the history
(cherry picked from commit d92f662)
  • Loading branch information
axieum committed May 10, 2024
1 parent 388b15f commit b5db418
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ It is a **server-side** only mod, uses [JDA][jda] to interface with Discord, is
built on the [Fabric][fabric] mod loader, and is available for modern versions
of [Minecraft][minecraft] Java Edition.

> [!TIP]
> You only need to add the one mod jar to your server, e.g. `minecord-2.0.3+1.20.6.jar`.
#### Integrations

* [TextPlaceholderAPI][text-placeholder-api] by Patbox — for text
Expand All @@ -30,7 +33,7 @@ of [Minecraft][minecraft] Java Edition.

### 💬 Chat

[Chat](minecord-chat/README.md) is an addon that bridges chat-related events
[Chat](minecord-chat/README.md) is responsible for bridging chat-related events
between Minecraft and Discord.

* Multi-channel support
Expand Down Expand Up @@ -68,8 +71,8 @@ between Minecraft and Discord.

### 🪄 Commands

[Commands](minecord-cmds/README.md) is an addon that provides various
commands to interact with your Minecraft server from Discord.
[Commands](minecord-cmds/README.md) is responsible for providing various commands to interact with
your Minecraft server from Discord.

* Built-in commands ready to use
* `/uptime` — shows for how long the server has been online
Expand All @@ -83,8 +86,8 @@ commands to interact with your Minecraft server from Discord.

### 😇 Presence

[Presence](minecord-presence/README.md) is an addon that updates the bot
presence in Discord to show more detailed statuses.
[Presence](minecord-presence/README.md) is responsible for updating the bot presence in Discord to show
more detailed statuses.

* Built-in presence categories ready to use
* `starting` — used when the Minecraft server is starting
Expand All @@ -97,8 +100,8 @@ presence in Discord to show more detailed statuses.

### 📦 API

[API](minecord-api/README.md) is a gateway into the Minecord mod. It equips
developers with the tools necessary to integrate their mods with Discord.
[API](minecord-api/README.md) is a gateway into the Minecord mod. It equips developers with the
tools necessary to integrate their mods with Discord.

## Sponsors

Expand Down
2 changes: 1 addition & 1 deletion minecord-chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

## Minecord Chat

Minecord Chat is an addon to [Minecord](../README.md) that bridges chat-related
Minecord Chat is a module for [Minecord](../README.md) that bridges chat-related
events between Minecraft and Discord.
2 changes: 1 addition & 1 deletion minecord-cmds/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

## Minecord Commands

Minecord Commands is an addon to [Minecord](../README.md) that provides various
Minecord Commands is a module for [Minecord](../README.md) that provides various
commands to interact with your Minecraft server from Discord.
2 changes: 1 addition & 1 deletion minecord-presence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

## Minecord Presence

Minecord Presence is an addon to [Minecord](../README.md) that updates the bot
Minecord Presence is a module for [Minecord](../README.md) that updates the bot
presence in Discord to show more detailed statuses.

0 comments on commit b5db418

Please sign in to comment.