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 and organize package.json #177

Closed
wants to merge 4 commits into from
Closed

Improve readme and organize package.json #177

wants to merge 4 commits into from

Conversation

grikomsn
Copy link
Contributor

Hello there 👋🏻

Many thanks for the awesome plugin, thought I give back by updating the readme and a little bit of organizing the package.json structure for readability. Collapsible content below are image previews of the readme before and after updating.

Screenshot preview
Before After
image image

Let me know if there's anything I shoud revert or change.

@jbolda
Copy link
Owner

jbolda commented Mar 28, 2020

I haven't had a chance to fully review, but I wanted to say thanks @grikomsn 😊

Copy link
Owner

@jbolda jbolda left a comment

Choose a reason for hiding this comment

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

Is the markdown wraps coming from Prettier? I am fine switching it to wrapped text, but I would like something "standard" if we are going to do it.

LICENSE Outdated Show resolved Hide resolved
Comment on lines +25 to +32
"keywords": [
"gatsby",
"gatsby-plugin",
"gatsby-source",
"gatsby-source-airtable",
"airtable"
],
"license": "MIT"
Copy link
Owner

Choose a reason for hiding this comment

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

Is there a guide that you are using to sort these? I would expect these make most sense under author.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's no guide for sorting the keywords

<!-- markdownlint-disable MD033 MD041 -->
<div align="center">

![gatsby-source-airtable](./header.png)
Copy link
Owner

Choose a reason for hiding this comment

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

Lovely!

@grikomsn
Copy link
Contributor Author

grikomsn commented Apr 1, 2020

Is the markdown wraps coming from Prettier? I am fine switching it to wrapped text, but I would like something "standard" if we are going to do it.

I manually wrapped it, but Prettier using --prose-wrap works better. Forgot the option exists. 😅

Maybe adding husky as a devDependency to format sources before commiting would be great.

@jbolda
Copy link
Owner

jbolda commented Apr 1, 2020

I just don't want to manually wrap it from now and into the future 😄 . I just updated prettier if you wanted to merge in from master and add a command to take care of running prettier for us.

Co-Authored-By: Jacob Bolda <me@jacobbolda.com>
@grikomsn
Copy link
Contributor Author

grikomsn commented Apr 1, 2020

Since there are new changes from upstream, I'll close this PR and create another from the latest upstream commits (#180).

@grikomsn grikomsn closed this Apr 1, 2020
@jbolda
Copy link
Owner

jbolda commented Apr 1, 2020

I think we could have taken care of it in this PR, but no worries. Do you plan to open another PR with the readme updates? 🙏 That logo was 🔥 .

@grikomsn
Copy link
Contributor Author

grikomsn commented Apr 1, 2020

Definitely will create another PR after #180 is merged ✨

@grikomsn grikomsn deleted the develop/improve-readme branch April 1, 2020 22:29
@grikomsn grikomsn mentioned this pull request Apr 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants