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
Centered logo README #355
Centered logo README #355
Conversation
The Amber's description was taken from https://www.crystalvaults.com/crystal-encyclopedia/amber |
@faustinoaq - Overall, I think this looks good. My only issue is that if this is all the content "above the fold" (what you see before scrolling), then it doesn't say much about the amber framework specifically. "Fun. Statically Typed, High Performance" can describe a lot of Crystal apps. I think we should have something a little more specific, so whoever sees the readme knows what Amber is and why they would use it. The website has: "Amber is a web application framework written in Crystal inspired by Kemal, Rails, Phoenix and other popular application frameworks." That sounds good for a description, but may be too long to go right under the logo. I like "Fast as Phoenix, Easy as Rails" It's been pointed out that Phoenix isn't actually that fast, but that is the perception it has. I think if we said "Faster than Phoenix, Easy as Rails" then we might get some blowback. Maybe "Production grade Web Applications out of the box" |
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.
:)
Be ware that breaks a layout of readme generated by |
@veelenga Does Crystal Markdown support embedded HTML? |
@eliasjpr I just saw your comment on gitter channel 😅
So: Maybe the Amber meaning is misleading? 😅 one of the world’s oldest and most coveted treasures, a “Gold of the Sea” intrinsically formed by light and life |
Nope: Markdown.to_html("<a href='https://'></a>")
=> "<p><a href='https://'></a></p>" I read somewhere Crystal sanitizes left angle bracket for security reasons. |
@faustinoaq How about: Amber makes building web applications fast, simple, and enjoyable - with fewer bugs and blazing fast performance. |
@faustinoaq - Regarding the "Faster than Phoenix, Easy as Rails" statement - I just think they will both require some backup (maybe directly in the readme, in a section further down). For "Faster than Phoenix" - If the new round of TechEmpower benchmarks come out, we can (hopefully) point to those, assuming the numbers are faster than Phoenix. For "Easy as Rails" - that is more subjective, but we could show an example of scaffolding a blog with user authentication via command line - that is compelling proof. |
@marksiemers those are bold statements. |
@eliasjpr - Agreed. The Crystal tagline "Fast as C, Slick as Ruby" was the inspiration for the style "Blank as This, Blank as That" If a comparison is valuable, something complementary could work better than "fightin' words": "Fast as Phoenix, Easy as Rails" Although, we could consider avoiding comparisons altogether. A different approach could be taken: |
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.
lgtm. i approve any slogan since its not my area of expertise.
@amberframework/core-team I vote for these:
Though maybe "Elegant Syntax", "Easy Syntax", "Fun to Code" or something else would work better for the very first line. |
@marksiemers Done! 👍 |
* Update design of README heading * Remove old links * Update slogan and paragraph * Update slogan
* Update design of README heading * Remove old links * Update slogan and paragraph * Update slogan Former-commit-id: aea08f5
Description of the Change
Add new header based on https://github.com/veelenga/ameba/blob/master/README.md by @veelenga
Alternate Designs
No
Benefits
Beautiful design 😄
Possible Drawbacks
No
/cc @amberframework/contributors