Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite JDA readme #2639

Merged
merged 16 commits into from
Apr 21, 2024
Merged

Rewrite JDA readme #2639

merged 16 commits into from
Apr 21, 2024

Conversation

MinnDevelopment
Copy link
Member

Pull Request Etiquette

Changes

  • Internal code
  • Library interface (affecting end-user code)
  • 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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Andre601 Andre601 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small typo

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Andre_601 <github@andre601.ch>
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
freya022

This comment was marked as resolved.

@Andre601
Copy link
Contributor

Andre601 commented Apr 1, 2024

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
Copy link
Contributor

I suggest 🔧 (or 🛠️) instead of🍴

README.md Outdated Show resolved Hide resolved
Since you can create your own implementation of `IEventManager`, this is a very versatile and configurable system.
If the aforementioned implementations don't suit your use-case you can simply create a custom implementation and
configure it on the `JDABuilder` with `setEventManager(...)`.
You can find a more thorough example with the [MessageLoggerExample](https://github.com/discord-jda/JDA/blob/master/src/examples/java/MessageLoggerExample.java) class.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should also added:
"You can also find the full list of events [here], along with the methods provided by ListenerAdapter [here]

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MinnDevelopment MinnDevelopment merged commit 48a4111 into master Apr 21, 2024
1 check passed
@MinnDevelopment MinnDevelopment deleted the docs/readme branch April 21, 2024 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants