search

franzejr / best-ruby

Ruby Tricks, Idiomatic Ruby, Refactoring and Best Practices
http://franzejr.github.io/best-ruby/
2.39k stars 219 forks source link

Display all options list in README. #69

Closed SagareGanesh closed 7 years ago

SagareGanesh commented 8 years ago

Hi, It will be better if we display all options list in README like faker gem. There are 2 advantage of this

  1. Easy to understand.

  2. Decrease one step in search engine.

    Is it make sense? thoughts?

    I can create PR, just let me know

franzejr commented 7 years ago

@SagareGanesh , this is a good idea..But I suppose the README will be too long. Furthermore, we are using gitbook to generate the website and then we need to make folders to keep this structure. The generated website is on www.best-ruby.com

SagareGanesh commented 7 years ago

@franzejr Thanks for your replay. If the gitbook generated websites requires such folder structure then its ok. I will check out how gitbook works internally.

Thanks.