ri_cal icon indicating copy to clipboard operation
ri_cal copied to clipboard

Improve formatting of the README

Open chadoh opened this issue 10 years ago • 4 comments

I found it very difficult to comprehend the README as it was written. I think better formatting is mostly all it needs.

Here's what I did:

  • Switched it to Markdown, instead of just text
  • Put long lines all on one line, to allow Github to wrap them optimally
  • Replaced tabs with two spaces
  • Made headers, code examples, etc use Markdown format

chadoh avatar Aug 19 '14 18:08 chadoh

+1

plentz avatar Sep 07 '14 21:09 plentz

I agree. The formatting IMO would improve the README significantly.

wpp avatar Sep 10 '15 07:09 wpp

+1

ashoda avatar Nov 19 '15 21:11 ashoda

@plentz 👋 you find those shopifolk everywhere! doesnt look like this is maintained? leaving this PR here though https://github.com/rubyredrick/ri_cal/pull/22

phoet avatar Feb 19 '21 15:02 phoet