GH-55 Add README.md by CitralFlo · Pull Request #55 · EternalCodeTeam/multification · GitHub
Skip to content

GH-55 Add README.md#55

Merged
Jakubk15 merged 13 commits into
masterfrom
readme
Dec 31, 2024
Merged

GH-55 Add README.md#55
Jakubk15 merged 13 commits into
masterfrom
readme

Conversation

@CitralFlo

Copy link
Copy Markdown
Member

No description provided.

@CitralFlo

Copy link
Copy Markdown
Member Author

@CitralFlo CitralFlo changed the title Readme and version bump down GH-55 Readme and version bump down Oct 17, 2024
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread buildSrc/src/main/kotlin/Versions.kt Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@Jakubk15

Copy link
Copy Markdown
Member

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Oct 20, 2024

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
README.md (3)

3-3: Add alt text to the banner image.

Hey there! It'd be great if you could add some alt text to the banner image. This helps make your README more accessible to everyone.

🧰 Tools
🪛 Markdownlint

3-3: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


99-99: Let's polish this sentence.

This sentence could use a bit of tweaking. How about:
"Setting up configuration is easy in both CDN and Okaeri configs. To add messages to the configuration, create a variable in the config with the class Notice or BukkitNotice. You can also use a builder. After plugin deployment, you can find messages in the configuration file."

🧰 Tools
🪛 LanguageTool

[uncategorized] ~99-~99: You might be missing the article “a” here.
Context: ...d messages to the configuration, create variable in config with class Notice or `Bukkt...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[uncategorized] ~99-~99: You might be missing the article “the” here.
Context: ...uration, create variable in config with class Notice or BukktiNotice. You can als...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~99-~99: Possible missing comma found.
Context: ... You can also use builder. After plugin deploy you can find messages in configuration ...

(AI_HYDRA_LEO_MISSING_COMMA)


101-101: Quick heading fix.

Let's remove the period at the end of this heading to keep it consistent with Markdown style.

🧰 Tools
🪛 Markdownlint

101-101: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f2e7ec4 and ebc89a0.

⛔ Files ignored due to path filters (1)
  • assets/readme-banner.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • README.md (1 hunks)
  • buildSrc/src/main/kotlin/Versions.kt (1 hunks)
  • examples/bukkit/src/main/java/com/eternalcode/example/bukkit/config/MessagesConfig.java (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~99-~99: You might be missing the article “a” here.
Context: ...d messages to the configuration, create variable in config with class Notice or `Bukkt...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[uncategorized] ~99-~99: You might be missing the article “the” here.
Context: ...uration, create variable in config with class Notice or BukktiNotice. You can als...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~99-~99: Possible missing comma found.
Context: ... You can also use builder. After plugin deploy you can find messages in configuration ...

(AI_HYDRA_LEO_MISSING_COMMA)

🪛 Markdownlint
README.md

101-101: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


3-3: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

🔇 Additional comments (5)
buildSrc/src/main/kotlin/Versions.kt (1)

5-5: Hey there! Just checking on this version change.

I noticed you changed the ADVENTURE_API version. Is this intentional? It might be good to double-check if everything still works smoothly with this older version.

Let's make sure this change doesn't cause any hiccups:

✅ Verification successful

ADVENTURE_API Version Update Verified ✅

I've confirmed that the ADVENTURE_API version "4.17.0" is consistently used throughout the codebase. Everything looks good!

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the new version is used consistently
rg "4.17.0" --type kotlin

Length of output: 101

examples/bukkit/src/main/java/com/eternalcode/example/bukkit/config/MessagesConfig.java (1)

25-25: Nice color update!

The subtitle now uses a cool gradient instead of the previous tag. It'll look prettier for players!

README.md (3)

15-30: Great intro! Consider a small tweak.

The introduction looks good! It might be worth tweaking line 17 as suggested earlier to make it even clearer.


32-39: Setup looks good, but could use more details.

The setup instructions are clear, but it might be helpful to add more info about CDN/Okaeri configuration as suggested earlier.


41-97: Code examples look great!

The code examples are really helpful. Don't forget to remove 'private' from line 83 as suggested earlier.

Rollczi and others added 7 commits November 11, 2024 15:30
Co-authored-by: Jakubk15 <77227023+Jakubk15@users.noreply.github.com>
Co-authored-by: Jakubk15 <77227023+Jakubk15@users.noreply.github.com>
Co-authored-by: Jakubk15 <77227023+Jakubk15@users.noreply.github.com>
Co-authored-by: Jakubk15 <77227023+Jakubk15@users.noreply.github.com>
@Rollczi Rollczi changed the title GH-55 Readme and version bump down GH-55 Add README.md Nov 11, 2024

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
README.md (2)

3-3: Add alt text to the banner image

Adding alt text will make the README more accessible for screen readers.

-![](/assets/readme-banner.png)
+![Multification Banner](/assets/readme-banner.png)
🧰 Tools
🪛 Markdownlint

3-3: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


37-45: Consider adding version compatibility information

It would be helpful to specify which Minecraft versions are supported by the library.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ebc89a0 and 15c074e.

⛔ Files ignored due to path filters (1)
  • assets/readme-banner.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • README.md (1 hunks)
  • examples/bukkit/src/main/java/com/eternalcode/example/bukkit/config/MessagesConfig.java (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • examples/bukkit/src/main/java/com/eternalcode/example/bukkit/config/MessagesConfig.java
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~142-~142: Possible missing comma found.
Context: ...ile, use the following code in the init method such as onEnable: ```java MessagesCo...

(AI_HYDRA_LEO_MISSING_COMMA)

🪛 Markdownlint
README.md

118-118: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


124-124: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


132-132: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


140-140: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


159-159: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


173-173: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


182-182: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


3-3: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

🔇 Additional comments (2)
README.md (2)

20-32: Great job with the feature list!

The emoji usage makes the features stand out nicely, and the descriptions are clear and concise.


108-192: Configuration documentation looks complete

The setup instructions and examples for both CDN and Okaeri are clear and well-documented. This addresses the previous review comment about better configuration explanation.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~142-~142: Possible missing comma found.
Context: ...ile, use the following code in the init method such as onEnable: ```java MessagesCo...

(AI_HYDRA_LEO_MISSING_COMMA)

🪛 Markdownlint

118-118: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


124-124: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


132-132: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


140-140: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


159-159: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


173-173: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


182-182: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

@imDMK imDMK removed their request for review December 22, 2024 17:24
@Jakubk15 Jakubk15 merged commit ffa9816 into master Dec 31, 2024
@Jakubk15 Jakubk15 deleted the readme branch December 31, 2024 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants