-
Notifications
You must be signed in to change notification settings - Fork 20
Bring text from "Understanding Sheer" wiki page into README #94
Conversation
|
Fixes #83 |
|
This is fantastic-- sheer feels all grown up now! |
|
This is awesome @willbarton A few stylistic comments, none of which I think should hold up this being merged if it doesn't make sense to tackle them now:
|
|
I think Ans's first bullet is worth addressing before merge.
|
|
@anselmbradford Ok, I've taken care of both those points in 1f17392 and d7ffca4. Testing should absolutely be in there, and that's an oversight on my part. The bulleted lists... I copied them straight from the output of |
README.md
Outdated
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.
Please capitalize Homebrew.
|
All good with me, now! 👍 @rosskarchner, ready for mergifcation? |
|
Roll that beautiful bean footage. |
Bring text from "Understanding Sheer" wiki page into README
This PR is a significant overhaul of the Sheer README with the goal of making it clearer what Sheer does and can be used for, and how to use it (API documentation both for python developers and for front-ends). This includes a lot of the same information as the old README, but in some different places.
It removes the section about Jekyll because, honestly, coming to Sheer for the first time that certainly confused me, because however Sheer might have begun life it's a very different beast from Jekyll right now.
I've also provided some links to Elasticsearch documentation interspersed with the content, since Sheer uses Elasticsearch relatively transparently.
@dpford contributed to this while it was in the wiki. I welcome any other suggestions on how to make Sheer more understandable. It's not hard, it's just misunderstood.
You can view the updated README in my fork.
Reviewers
@rosskarchner
@dpford
@kurtwall