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

Centered logo README #355

Merged
merged 9 commits into from Nov 4, 2017
Merged

Centered logo README #355

merged 9 commits into from Nov 4, 2017

Conversation

faustinoaq
Copy link
Contributor

@faustinoaq faustinoaq commented Nov 2, 2017

Description of the Change

Add new header based on https://github.com/veelenga/ameba/blob/master/README.md by @veelenga

screenshot_20171102_151431

Alternate Designs

No

Benefits

Beautiful design 😄

Possible Drawbacks

No

/cc @amberframework/contributors

@faustinoaq
Copy link
Contributor Author

The Amber's description was taken from https://www.crystalvaults.com/crystal-encyclopedia/amber

@marksiemers
Copy link
Contributor

@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"

Copy link
Member

@elorest elorest left a comment

Choose a reason for hiding this comment

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

:)

@veelenga
Copy link
Contributor

veelenga commented Nov 3, 2017

Be ware that breaks a layout of readme generated by crystal docs. I'm not sure if this is relevant for Amber repo.

@faustinoaq
Copy link
Contributor Author

@veelenga Does Crystal Markdown support embedded HTML?

@faustinoaq
Copy link
Contributor Author

I think if we said "Faster than Phoenix, Easy as Rails" then we might get some blowback.

Is it good or bad?

screenshot_20171103_114933

@faustinoaq
Copy link
Contributor Author

@eliasjpr I just saw your comment on gitter channel 😅

Amber makes building web applications simply fast, reduced bugs, and enjoyable without sacrificing performance.

So:

screenshot_20171103_115219

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

@veelenga
Copy link
Contributor

veelenga commented Nov 3, 2017

Does Crystal Markdown support embedded HTML?

Nope:

 Markdown.to_html("<a href='https://'></a>")
 => "<p>&lt;a href='https://'>&lt;/a></p>"

I read somewhere Crystal sanitizes left angle bracket for security reasons.

@marksiemers
Copy link
Contributor

@faustinoaq How about:

Amber makes building web applications fast, simple, and enjoyable - with fewer bugs and blazing fast performance.

@marksiemers
Copy link
Contributor

marksiemers commented Nov 3, 2017

@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.

@eliasjpr
Copy link
Contributor

eliasjpr commented Nov 3, 2017

@marksiemers those are bold statements. Faster than Phoenix I don't want to start a battle royale with a more established community. I also feel it goes against part of our philosophy Humility

@marksiemers
Copy link
Contributor

@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"
"Rails Productivity with Phoenix Speed"

Although, we could consider avoiding comparisons altogether.

A different approach could be taken:
"Fast. Easy. Enjoyable"
"Enjoyable. Compiled. Performant."
"Coder Happiness with Compiled & Concurrent Performance"
"Clear, Concurrent, Compiled Code"

Copy link
Member

@drujensen drujensen left a 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.

@marksiemers
Copy link
Contributor

marksiemers commented Nov 3, 2017

@amberframework/core-team

I vote for these:

Fun Syntax. Reliable Static Typing. Compiled Speed.

Amber makes building web applications fast, simple, and enjoyable - with fewer bugs and blazing fast performance.

Though maybe "Elegant Syntax", "Easy Syntax", "Fun to Code" or something else would work better for the very first line.

@faustinoaq
Copy link
Contributor Author

@marksiemers Done! 👍

screenshot_20171103_192718

@eliasjpr eliasjpr merged commit d327154 into amberframework:master Nov 4, 2017
@faustinoaq faustinoaq deleted the centered-logo-readme branch November 4, 2017 12:45
elorest pushed a commit that referenced this pull request Nov 17, 2017
* Update design of README heading

* Remove old links

* Update slogan and paragraph

* Update slogan
elorest pushed a commit that referenced this pull request Nov 17, 2017
* Update design of README heading

* Remove old links

* Update slogan and paragraph

* Update slogan


Former-commit-id: aea08f5
@faustinoaq faustinoaq added this to Done in Framework 2018 May 5, 2018
@faustinoaq faustinoaq removed this from Done in Framework 2018 Jun 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

6 participants