Skip to content

Commit 1ad10d5

Browse files
committed
Improve README.md
1 parent 0fc3c78 commit 1ad10d5

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
[bc-maven-central-shield]: https://img.shields.io/maven-central/v/io.github.freya022/BotCommands?versionPrefix=3
2-
[bc-maven-central-link]: https://mvnrepository.com/artifact/io.github.freya022/BotCommands/latest
3-
[bc-jitpack-shield]: https://img.shields.io/badge/Snapshots-JitPack-blue
1+
[bc-maven-central-shield]: https://img.shields.io/maven-central/v/io.github.freya022/BotCommands?label=Maven%20central&logo=apachemaven&versionPrefix=3
2+
[bc-maven-central-link]: https://central.sonatype.com/artifact/io.github.freya022/BotCommands
3+
[bc-jitpack-shield]: https://img.shields.io/badge/Snapshots-blue?logo=jitpack
44
[bc-jitpack-link]: https://jitpack.io/#freya022/BotCommands
55
[bc-releases]: #installation
6-
[jda-version]: https://img.shields.io/badge/JDA-5.6.1+-important?logo=data:image/webp;base64,AAAAIGZ0eXBhdmlmAAAAAGF2aWZtaWYxbWlhZk1BMUIAAADybWV0YQAAAAAAAAAoaGRscgAAAAAAAAAAcGljdAAAAAAAAAAAAAAAAGxpYmF2aWYAAAAADnBpdG0AAAAAAAEAAAAeaWxvYwAAAABEAAABAAEAAAABAAABGgAAAW4AAAAoaWluZgAAAAAAAQAAABppbmZlAgAAAAABAABhdjAxQ29sb3IAAAAAamlwcnAAAABLaXBjbwAAABRpc3BlAAAAAAAAAEAAAABAAAAAEHBpeGkAAAAAAwgICAAAAAxhdjFDgQAMAAAAABNjb2xybmNseAACAAIABoAAAAAXaXBtYQAAAAAAAAABAAEEAQKDBAAAAXZtZGF0EgAKCRgVf/+SBAQNCDLeAhmAEEkChYLB7ntYGXOA0f2AO1y+OQSAZ/+4k/+8cHSs3agNudzbWMa88pAwhg7wt5T3r++KAdrox72GcnCJ+5eYdRm/bCIY7FzXNyzWx5sF4aIG6mHy+63fAvwhY7b8VFs1rQqElmxoQX1OZY+UPfHezHFzj1Wp4NX+rFvG6mZn8GQPriAH6yK8jwUJOwZn6HtI17V3Qt0+dvvues8+LINU3aUW/JSAHLOgDwuVDT3QO+YusPXmHLAUZLovrOnPBzkB9vbDkFYynaRt4qnVpeBhj1bpRbEMhFaIg0UOOPSalejx1nfaHYqqrcv8LEQJUT2UV5QdllmG5ed/SsHJP/tZ3MrllECw0l444JMXfmeP5+mO/4sy0FiasxeLgFZz4c9hyFH77PSfQfUdsYhgUn03Rim6F73SztGxVw0fyaNF/lzJ+ZdKgfdSlwTN5oTIqjicDvpNE4zCQpaCHnJw
6+
[jda-version]: https://img.shields.io/badge/JDA-5.6.1+-important?logo=data:image/svg%2bxml;base64,PHN2ZwogICB2ZXJzaW9uPSIxLjEiCiAgIGlkPSJzdmczNzMxIgogICB3aWR0aD0iMjQ3LjQ5NzYyIgogICBoZWlnaHQ9IjE4MC4zMjIxNiIKICAgdmlld0JveD0iMCAwIDI0Ny40OTc2MiAxODAuMzIyMTYiCiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiAgPHBhdGgKICAgICBzdHlsZT0iZmlsbDojZmZmZmZmO3N0cm9rZS13aWR0aDoxLjMzMzMzIgogICAgIGQ9Ik0gNDcuMTc4MTUzLDE3OC4yODk5NiBDIDMyLjkxNzg0MiwxNzUuMTk3NDEgMjAuMjA5MDc0LDE2OC4yOTI1MiA5LjUxMDEzODgsMTU3LjgyNDI5IEwgLTIuMTgwMTUwNGUtNiwxNDguNTE5MjMgMC44NjgzMDU4MiwxMzMuMzE2MTkgQyAyLjczMjU1NTgsMTAwLjY3NTM5IDEyLjI4Nzk4MSw2Mi4xMTU4MSAyNS43NTg2MzksMzIuODc0NzUgMzEuMzg1NDE0LDIwLjY2MDU4MSAzNS41NjU1NDYsMTYuOTkzMzIxIDUzLjA5MDUyNiw4Ljg5NjI4MzYgNjcuMTc3ODM2LDIuMzg3NTQzNiA4Ni42NjQ3MDYsLTEuNzAyODI1NCA5MC45NTQ2MDYsMC45NDg0NzE1NSA5Mi4yMTYwNDYsMS43MjgwODM2IDg5LjAzMzc4NiwzLjQyMjY1OTYgODAuNzYyMjU2LDYuMzc1OTkxNiA2Ny42NTc5MzYsMTEuMDU0ODUyIDUwLjA4MDM2MSwxOS45ODE5MzMgNDMuNzQ4ODAxLDI1LjE3MzkzIDM5LjkwOTU4NiwyOC4zMjIxNSA0MC4xMDk4ODksMjguMjkzODggNDguNzMxOTA0LDI0LjQ3MDY2IDcyLjgzNzMwNiwxMy43ODE3MDEgOTUuMzI4ODA2LDkuMjA3MzY3NiAxMjMuNzQ4ODEsOS4yMTM2Nzc2IGMgMjYuNjY5NTQsMC4wMDU5IDQ3LjM3NDMyLDQuMzA4MDU4NCA2OS44NjcxOCwxNC41MTczMzI0IDkuMTcwODgsNC4xNjI1NyA5Ljc1MzA4LDQuMjgyOTIgNi4xMzI4MiwxLjI2NzczIC01LjMxOTQzLC00LjQzMDM0NyAtMjQuNTM3NzksLTE0LjI0Nzg0MiAtMzUuMzMzMzQsLTE4LjA0OTY1NDQgLTEwLjQzMTYsLTMuNjczNjQ0IC0xMC4wNzIwMSwtMy40MjUxNzcgLTguMjA3ODYsLTUuNjcxMzM4IDIuODkzMDgsLTMuNDg1OTQ3IDIyLjczMzAyLDAuNTExMTg0IDM4LjQ0MDczLDcuNzQ0NjEgMTcuMjQ1MSw3Ljk0MTM5MzQgMjEuNDc3NTQsMTEuNjY3OTA3NCAyNy4wOTA2MywyMy44NTIzOTI0IDEzLjQ3MDY3LDI5LjI0MTA2IDIzLjAyNjA4LDY3LjgwMDY0IDI0Ljg5MDMzLDEwMC40NDE0NCBsIDAuODY4MzEsMTUuMjAzMDQgLTkuNTEwMTMsOS4zMDUwNiBjIC0xMC44OTI5NiwxMC42NTgwNyAtMjMuNDE5NzEsMTcuMzczOTIgLTM4LjI3NjkzLDIwLjUyMTA4IC0xNS41NjQ1LDMuMjk2OTkgLTE2LjQyOTI2LDMuMDc5MjYgLTIzLjYyODQxLC01Ljk0OTI1IC02LjU3MjkzLC04LjI0MzE3IC03LjYwOTc1LC0xMC43MDIxNiAtNC41MTI0OCwtMTAuNzAyMTYgMy44MzIyLDAgMjAuOTU4MDgsLTkuNjkzNTcgMjcuNDcwNiwtMTUuNTQ4ODkgMy43NDY4NSwtMy4zNjg3NCA2LjYwNTk3LC02LjMzMTQ3IDYuMzUzNiwtNi41ODM4MyAtMC4yNTIzNywtMC4yNTIzNyAtNC45MjU3NSwxLjg2NzIxIC0xMC4zODUyOSw0LjcxMDIgLTM3LjM1MjQsMTkuNDUwNzcgLTc5LjE1MzcyLDIyLjcwNzEyIC0xMTkuMjExMjQ0LDkuMjg2NjMgLTYuNTc5NzMsLTIuMjA0NDIgLTE2LjMzMjM2LC02LjI5NzUgLTIxLjY3MjUsLTkuMDk1NzQgLTUuMzQwMTQ3LC0yLjc5ODI0IC05LjcwOTM1OCwtNC42MzU2OCAtOS43MDkzNTgsLTQuMDgzMiAwLDEuNTAxNDggOS4yNzQxNzgsOS41Nzk0NCAxNS4xODk0OTgsMTMuMjMwMzIgMi44NTQyMywxLjc2MTU5IDguNDAyOTgsNC41MDg5NiAxMi4zMzA1Niw2LjEwNTI0IGwgNy4xNDEwNiwyLjkwMjM1IC02Ljk5NjE5LDguODcxNzkgYyAtNy45MTk3MiwxMC4wNDI5MiAtOC44MTk5OCwxMC4yODg4IC0yNC45MDIyNDMsNi44MDExMyB6IG0gMjAuNTg0MjczLC02MS4xODI0MyBjIDguNjE5OTMsLTMuNjAxNjQgOS45NzU3NCwtNy45MTM5MyA5Ljk4MTM5LC0zMS43NDY5IGwgMC4wMDUsLTIxIEggNjQuNDE1NDY2IDUxLjA4MjEzNSB2IDQuNjY2NjYgNC42NjY2NyBoIDYuNjY2NjcxIDYuNjY2NjYgdiAxNC42NjY2NyBjIDAsMTMuMTgwNCAtMC4yODczNiwxNC45NTQwMiAtMi44MzU3NSwxNy41MDI0MSAtMi40MjA1OCwyLjQyMDU5IC0zLjg4NDY0LDIuNzI3NTEgLTEwLDIuMDk2MzUgbCAtNy4xNjQyNDgsLTAuNzM5NDIgdiA1LjEyNTg4IGMgMCwyLjg1MzE1IDAuNzM4OTc0LDUuNDI0MDcgMS42NjY2NjYsNS43OTg0IDMuNTc0ODksMS40NDI1IDE3LjMxOTcyMiwwLjc4NTI0IDIxLjY4MDI5MiwtMS4wMzY3MiB6IG0gNTkuOTg2Mzg0LC0yLjg3MjQyIGMgMTQuODY5NTgsLTcuNzQ2OTYgMTguNDAyMzIsLTI4LjM5NzIzIDcuMDY2NjksLTQxLjMwNzc5IC01LjM3Nzk5LC02LjEyNTE5IC0xNC4xMTA5NSwtOC41NjY2OSAtMzAuNjQyMDMsLTguNTY2NjkgSCA5MS4wODIxMzYgdiAyNi44MDcxIDI2LjgwNzEgbCAxNS42NjY2NzQsLTAuNDgwNTUgYyAxMi42NDI4NCwtMC4zODc4IDE2LjY5NjA1LC0xLjAxNjg1IDIxLC0zLjI1OTE3IHogTSAxMDQuNDE1NDcsOTEuMDI3MjkgdiAtMTYgaCA1LjgwMjgzIGMgMTEuODUxOCwwIDE5LjAwMjM2LDkuMzA3NSAxNi4wOTksMjAuOTU1MTYgLTEuNjM0NjksNi41NTc5OSAtOC4xNzQ3NSwxMS4wNDQ4NCAtMTYuMDk5LDExLjA0NDg0IGggLTUuODAyODMgeiBtIDU4LjUwOTE0LDIxLjMzMzM0IDEuNTk3OSwtNS4zMzMzNCBoIDkuODkyOTYgOS44OTI5NiBsIDEuNTk3OTEsNS4zMzMzNCAxLjU5NzkxLDUuMzMzMzMgaCA3LjA2NDcgNy4wNjQ3MSBsIC00Ljc0NzEyLC0xMyBjIC0yLjYxMDkxLC03LjE1IC02LjkzNSwtMTkuMTQ4NzUgLTkuNjA5MDgsLTI2LjY2Mzg3IGwgLTQuODYxOTksLTEzLjY2Mzg4IGggLTggLTggbCAtNC44NjE5OCwxMy42NjM4OCBjIC0yLjY3NDA4LDcuNTE1MTIgLTYuOTk4MTgsMTkuNTEzODcgLTkuNjA5MDgsMjYuNjYzODcgbCAtNC43NDcxMiwxMyBoIDcuMDY0NyA3LjA2NDcxIHogbSA2LjI2Mjc2LC0xNy42NjY2NyBjIDAuNTIzMzcsLTEuNjUgMS45Mzc4LC01LjkwMjEzIDMuMTQzMTYsLTkuNDQ5MiBsIDIuMTkxNTcsLTYuNDQ5MTkgMi40NTE1NSw3Ljc4MjUyIGMgMS4zNDgzNCw0LjI4MDQgMi43Mzg1NCw4LjUzMjU0IDMuMDg5MzMsOS40NDkyIDAuNDU0MDgsMS4xODY2IC0xLjE1NzQzLDEuNjY2NjcgLTUuNTk0NzEsMS42NjY2NyAtNS44NTY0LDAgLTYuMTc1MDgsLTAuMTgxMDQgLTUuMjgwOSwtMyB6IiAvPgo8L3N2Zz4K
77
[jda-releases]: https://github.com/discord-jda/JDA/releases
8-
[discord-shield]: https://discord.com/api/guilds/848502702731165738/embed.png?style=shield
8+
[discord-shield]: https://img.shields.io/discord/848502702731165738?logo=discord&logoColor=white&color=e0e3ff&label=Chat
99
[discord-invite]: https://discord.gg/frpCcQfvTz
10-
[kdoc-shield]: https://img.shields.io/badge/API_reference-KDoc-blue
10+
[kdoc-shield]: https://img.shields.io/badge/KDoc-Docs-blue?logo=kotlin&labelColor=2b303b
1111
[kdoc-link]: https://docs.bc.freya02.dev
12-
[wiki-shield]: https://img.shields.io/badge/Wiki-Home-blue
12+
[wiki-shield]: https://img.shields.io/badge/Wiki-Home-blue?logo=materialformkdocs&labelColor=2b303b
1313
[wiki-link]: https://bc.freya02.dev/3.X
1414

1515
<img align="right" src="assets/logo.svg" height="150" alt="BotCommands logo">
@@ -135,8 +135,6 @@ OOP, [JDA](https://github.com/discord-jda/JDA) and Dependency Injection basics b
135135
* An [OpenJDK 17+](https://adoptium.net/temurin/releases/?version=21) installation
136136
* A competent IDE (I recommend IntelliJ IDEA, you can't go wrong with it in Java & Kotlin, + Live Templates)
137137
* (Only Java) Enable method parameters names, please refer to the [wiki page](https://bc.freya02.dev/3.X/using-botcommands/parameter-names/)
138-
* (Recommended) Use [HotswapAgent](https://github.com/HotswapProjects/HotswapAgent) in development, to avoid restarting too often
139-
* (Recommended) Use [stacktrace-decoroutinator](https://github.com/Anamorphosee/stacktrace-decoroutinator), to get clearer stack traces in suspending code
140138

141139
Head over to [the wiki](https://bc.freya02.dev/3.X/setup/getting-started/) to get started,
142140
you can also check out the [examples](src/examples).
@@ -168,6 +166,15 @@ dependencies {
168166
Alternatively, you can use Jitpack to use **snapshot** versions,
169167
you can refer to [the JDA wiki](https://jda.wiki/using-jda/using-new-features/) for more information.
170168

169+
## Modules
170+
The base `BotCommands` artifact will include modules often used, while others are optional.
171+
172+
### Default modules
173+
- [`BotCommands-core`](./BotCommands-core): Root module which contains most features
174+
175+
### Optional modules
176+
- [`BotCommands-spring`](./BotCommands-spring): Support for Spring Boot
177+
171178
## Sample usage
172179
Here is how you would create a slash command that sends a message in a specified channel.
173180
<details>

0 commit comments

Comments
 (0)