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

Update README #226

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Update README #226

wants to merge 6 commits into from

Conversation

iThorgrim
Copy link

@iThorgrim iThorgrim commented Jan 22, 2025

This pull request proposes a "comprehensive" update to the mod-eluna Readme. The goal is to improve readability, adopt a modern style, and provide clearer.

Key changes include:

  • A more engaging introduction with badges for key resources.
  • A structured layout with an interactive table of contents.
  • Reorganized sections for easy access to essential information.
  • Updated command examples and links to useful resources.

Main Changes

  1. Visual Introduction:
    • Added badges, a tagline, and a centered layout for better first impressions.
  2. Improved Structure:
    • Introduced an interactive table of contents.
    • Highlighted community and contribution sections.
  3. Installation Instructions:
    • Added options for selecting the Lua version.
  4. Documentation and Resources:
    • Linked to official documentation and APIs (link updated).
    • Grouped community contributions in a dedicated section.
  5. Community Contributions:
    • New section showcasing recent additions in a clear and concise list (and linbk to a new files with all new features).

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
* [License](https://github.com/ElunaLuaEngine/Eluna/blob/master/docs/LICENSE.md)


## Additions from Eluna/master
Copy link
Member

Choose a reason for hiding this comment

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

We need that list around until there's another reliable way of tracking.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, that's why I've put the link to a new .md file, so as not to have a list that will grow over time on the “ReadMe” presentation of the module itself.

Making a list on the main ReadMe doesn't make sense from my point of view, but adding a new .md file (COMMUNITY_UPDATES.md) with a well-ordered list seems more relevant to me.

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.

2 participants