phari_doc_gen 2.0.2

Hi there buddy! I've heard you've been looking for a simple and functional documentation generator for this Ruby web app of yours. So here goes a brief tutorial on how to use this little gem developed by Phari Solutions. First things first. To use this gem, you will need to be following the sinatra/padrino patterns. If you're using these frameworks probably you already matched the requisites, otherwise, organize your folders properly. Your project tree has to be organized in a main directory called 'api' that must contain another folder 'app' with three other directories 'models', 'helpers' and 'controllers' within. The files will also have to be especifically named. But we'll look further into it later. Now, requisites aside, Phari Doc Generator will provide you an easy way to generate documentation for your projects. The result will be a project page with a description that can be written using a simplified markdown syntax that is going to be explained ahead. Also, each ruby Class will have it's own page especifying it's helper methods and controller routes including their inputs, outputs and descriptions. The gem includes an executable file and the classes that can be used individually, providing the possibility to use the generator for any project structure.