search

joeyespo / grip

Preview GitHub README.md files locally before committing them.
MIT License
6.45k stars 423 forks source link

Clarify that this sends your markdown to GitHub #251

Closed courajs closed 5 years ago

courajs commented 6 years ago

The current wording allows for the misinterpretation that the rendering is being done locally. "Github markdown API" could mean a library published by GitHub, and "The styles come directly from GitHub" could mean just the CSS stylesheet. This should be corrected, because if misinterpreted this way it leads to 2 false assumptions:

I know information later in the readme talks about API rate limits and such, but many people won't read past the Usage section (myself included apparently). I think in particular the repeated mentions of a "local readme file" gave me this mistaken impression.

I think mentioning REST and saying that the rendering is done by GitHub is sufficient, but there may be some other change that clarifies this better.

dtzWill commented 6 years ago

Ha! Yes please! Not a problem for me, but I was definitely misled at first.

joeyespo commented 6 years ago

This sounds good to me. Good suggestion!

One minor tweak maybe. Could you remove the "REST" addition? It's slightly noisier and doesn't make much of a difference to the reader if it's sent using the REST API vs the Graphql one.

Also, any chance can you rebase this onto master latest?