libmacaroons icon indicating copy to clipboard operation
libmacaroons copied to clipboard

Adding markdown formatted README

Open orenfromberg opened this issue 6 years ago • 1 comments
trafficstars

what is this?

This branch adds a README.md file that is a markdown formatted version of the existing README file.

why

The benefit of using markdown is that GitHub can render syntax highlighting for python and bash script, as well as format the documentation in a responsive way for mobile browsers.

requested feedback

  • should the existing README be removed?

orenfromberg avatar Nov 08 '19 03:11 orenfromberg

I don't remember if it was this repository or another where I explained the reason I don't do a README.md as opposed to a README is it gives me flexibility to just write without having to keep a different flavor of markdown in my mind for each service that uses it. I would be willing to accept the other patches and/or a convincing discussion about the marrkdown.I belive it's this repo where the README is parsed as is to create some tests.

rescrv avatar Feb 19 '21 17:02 rescrv