Add README file#2
Open
Codestech1 wants to merge 3 commits into
Open
Conversation
JSDforJ
requested changes
Jul 13, 2026
JSDforJ
left a comment
JSDforJ
left a comment
Member
There was a problem hiding this comment.
keep in mind that these are just my ideas and suggestions and aren't necessarily required changes
| ## Use cases | ||
| This library was made with many use cases in mind, for example: | ||
| - **Modular monolith architecture** - you can use Modules to split features of your project into multiple independant modules. This allows the application to keep running, even if one of those modules fail. | ||
| - **Creating and removing complex environments at any time at runtime** - for example, Hypejet uses this library to create and load minigame rounds, which are then fully unloaded and removed. |
Member
There was a problem hiding this comment.
using "at" twice right in a row sounds pretty bad, maybe change to "-Creating and removing complex environments at any time during runtime" or similar
| This library was made with many use cases in mind, for example: | ||
| - **Modular monolith architecture** - you can use Modules to split features of your project into multiple independant modules. This allows the application to keep running, even if one of those modules fail. | ||
| - **Creating and removing complex environments at any time at runtime** - for example, Hypejet uses this library to create and load minigame rounds, which are then fully unloaded and removed. | ||
| - **And anywhere you need modular environment!** - Modules was designed to be feature-complete and provide advanced features. |
Member
There was a problem hiding this comment.
- the sentence "And anywhere you need modular environment!" does not make any sense
- "and provide advanced features." maybe change this to sound "fancier" if that makes sense
| - **And anywhere you need modular environment!** - Modules was designed to be feature-complete and provide advanced features. | ||
|
|
||
| ## Why Modules? | ||
| There are some adventages of using this library over others or custom approach: |
Member
There was a problem hiding this comment.
change this line to something like "Here's some advantages Modules has over similar libraries:"
| Pull requests are welcome. There are no strict requirements for now, however - if possible - please try to follow our code style. But don't worry, in case there is something wrong, it will most likely get corrected by maintainers. | ||
|
|
||
| ## License | ||
| This project was licensed under the terms of [Apache 2.0 License](LICENSE). |
Member
There was a problem hiding this comment.
Suggested change
| This project was licensed under the terms of [Apache 2.0 License](LICENSE). | |
| This project is licensed under the terms of [Apache 2.0 License](LICENSE). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a
READMEfile, explaining goals and use-cases of the project.