Rewrite JDA readme - Githubissues

discord-jda / JDA

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

Apache License 2.0

4.28k stars 737 forks source link

Rewrite JDA readme #2639

Closed MinnDevelopment closed 4 months ago

MinnDevelopment commented 5 months ago

Pull Request Etiquette

[x] I have checked the PRs for upcoming features/bug fixes.
[x] I have read the contributing guidelines.

Changes

[ ] Internal code
[ ] Library interface (affecting end-user code)
[x] Documentation
[ ] Other: _____

Closes Issue: NaN

Description

This rewrites the current README of JDA. Since this README has been around for such a long time, it needed some rework for the current state of the library. I've also heavily reduced the size of the README.

Andre601 commented 5 months ago

Given the date, I'm unsure if the most recent commit is a serious one or not...

If it is, then I would like to share my opinion that emojis in headers aren't really nice. Especially in GitHub since 1) They are rendered based on the OS, making them inconsistent and 2) Make header-links less intuitive (i.e. #-overview instead of just #overview).

Not sure what the opinions of everyone else here is on that tho.

freya022 commented 4 months ago

I suggest 🔧 (or 🛠️) instead of🍴