Open
Conversation
Contributor
Contributor
Author
|
One important thing to say is that cleaning this up (together with development guide which we already did) will make more space to focus on features/supported APIs. The README will look better if it's just intro, installation, features/API examples. |
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.
I suggest not mixing up performance details directly into README especially since we now use as source for our integrations pages. We are talking about performance optimization even before letting people install the gem which might be confusing or suggest the gem is somehow slow. For now, I only decoupled the info into BENCHMARKS.md (feel free to suggest a different name for the file), I'll likely submit more changes regarding the text itself. Btw it's great we have benchmarks and care about performance, but we should invite people to try the gem first and foremost. We can point them to this level of optimization later.