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

Improve README #917

Merged
merged 1 commit into from May 4, 2022
Merged

Improve README #917

merged 1 commit into from May 4, 2022

Conversation

Morriar
Copy link
Collaborator

@Morriar Morriar commented May 2, 2022

@Morriar Morriar requested a review from a team May 2, 2022 23:37
@Morriar Morriar self-assigned this May 2, 2022
Copy link
Member

@vinistock vinistock left a 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?

README.md Outdated Show resolved Hide resolved
@@ -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" />
Copy link
Member

Choose a reason for hiding this comment

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

❤️

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@Morriar Morriar force-pushed the at-doc branch 2 times, most recently from 6c8e8a6 to 9f956d4 Compare May 3, 2022 16:09
Copy link
Member

@paracycle paracycle left a 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
Copy link
Member

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:

Suggested change
* Signatures importation from the gems source code
* Importing of signatures from the gem source code

Copy link
Collaborator Author

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?

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@paracycle paracycle left a 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!

README.md Outdated Show resolved Hide resolved
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
@Morriar Morriar merged commit e2dfe3e into main May 4, 2022
@Morriar Morriar deleted the at-doc branch May 4, 2022 00:02
@shopify-shipit shopify-shipit bot temporarily deployed to production May 13, 2022 23:08 Inactive
@shopify-shipit shopify-shipit bot temporarily deployed to 0-8-stable May 30, 2022 13:45 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants