search

codeplant / simple-navigation

A ruby gem for creating navigations (with multiple levels) for your Rails, Sinatra or Padrino applications. Render your navigation as html list, link list or breadcrumbs.
http://simple-navigation-demo.codeplant.ch/
MIT License
885 stars 136 forks source link

Readme update #147

Closed simonc closed 10 years ago

simonc commented 10 years ago

I started this branch several days ago but since then you changed the README file. It's a proposal but I changed it to markdown, it seems to be the README stadard now. In addition the right HTML headings are used (but I may be punctilious here ^^).

I also added a code climate badge. It's still referencing the old repository, I can update it but it doesn't seem to work for now.

I also added a link to the online RDoc and instrcutions for contributions. Otherwise, I kept what you changed in the new README.

simonc commented 10 years ago

You can find the rendered version of the README here https://github.com/simonc/simple-navigation/blob/readme-update/README.md

I forgot to mention, I removed unnecessary instructions for RDoc generation since README is already used on rubydoc.info :)

andi commented 10 years ago

great :-)