New README.md for clarity #248
Merged
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
Contributor
Author
|
Just noticed a missed space after a the |
Contributor
Author
|
Also just noticed the Slack link is broken :/ |
aexol
approved these changes
Jan 20, 2022
Collaborator
|
Thanks man! I will deploy docs out of it today. For better readability |
Collaborator
Collaborator
|
new logo looks cool |
Contributor
Author
|
Awesome!! |
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.
Hi guys.
I spent a ton of time rewriting and working on the README for GraphQL Zeus. Mainly because I love the package, use it heavily and I want as many devs as possible to take it up and contribute and make it better and support it. And in so doing draw attention to GraphQL Editor too.
Previously I would refer friends and colleagues to the package and they would have a difficult time understanding how the package worked and how it would fit into their stack and workflow from the README. I've rewritten and re-organised it to be as clear as possible without completely getting rid of the original content.
You'll also notice that I had a designer work on the logo. This is because the original looked bad on dark mode on GitHub and also so that it would fit in more with GraphQL itself and the feel of GraphQL Editor. I have the file for the new logo in Figma and please feel free to make changes or let me know if you would like any changes. https://www.figma.com/file/d08GJKuHN8dKzSvOxDKMaJ/New-GraphQL-Zeus-Logo
Hope you guys like it. If you would like anything else changed please let me know and I'll handle it.