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
Improve README #917
Improve README #917
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work.
Is the PR linked in the description the correct one though?
@@ -1,60 +1,48 @@ | |||
> :warning: **Note**: This software is currently under active development. The API and interface should be considered unstable until a v1.0.0 release. | |||
|
|||
# Tapioca | |||
<p align="center"> | |||
<img alt="Tapioca logo" width="200" src="misc/tapioca-logo.svg" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️
6c8e8a6
to
9f956d4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, this is amazing!
README.md
Outdated
* Easy installation and configuration | ||
* Generation of RBI files for the gems used in your application | ||
* Automatic generation from your application's Gemfile | ||
* Signatures importation from the gems source code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe importation
is not the correct word here:
* Signatures importation from the gems source code | |
* Importing of signatures from the gem source code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I applied the first change but kept gems
plural as its used plural in the other bullet points if it's okay with you?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A final comment and then LGTM!
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Motivation
Closes https://github.com/Shopify/sorbet-issues/issues/248.