docs: minimalist readme#464
Open
ViniAbreu wants to merge 2 commits into
Open
Conversation
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
1 participant
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.
The Readme.md file is the main repository file, allowing us to quickly access important project information. With recent changes and middleware additions, it has become quite extensive and loaded with information already available on the repository page itself.
Providers
This information is very important, but it's too technical and detailed to be included in the readme, and we also have a dedicated section for this in our documentation.
Application Types
The same logic as for providers applies to this section.
Official and Unofficial Middleware
We received an excellent contribution, creating a dedicated section of the documentation to catalog all compatible middleware.
Delphi Versions
We also have a dedicated section in the documentation for this, with much more detail.
Contributors
We are already listed in the right-hand corner by GitHub itself.
Tests
The information was incorrect, and the badges would need to be changed with each version. Perhaps we can think of something better later, but at the moment I don't see how it works.