Implement documentation in Markdown

[shalvah]

Okay, not really a bug or something, but I feel it would make it easier to read and understand, without having to clone the repo, and on mobile too.

[isocroft]

You are very right. Working on this at the moment.

Thanks for the idea.

[shalvah]

I can take up the issue if you'd like.

…

On Wed, Jan 18, 2017, 17:42 Ifeora Okechukwu ***@***.***> wrote: You are very right. Working on this at the moment. Thanks for the idea. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#10 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ANsh8dtDj-QsjlHVEJd1_c-WEF1hwGFdks5rTkDogaJpZM4LmPjO> .

[isocroft]

@shalvah I'll be glad. Please, go ahead. I have just pushed an EASYDOCS.md file which contains a few things. Feel free to update it as necessary.

Thank you so very much for opting to take on this. I appreciate. The load on me concerning this repo is quite enormous.

[shalvah]

I noticed this in the easydocs file...

This command will add an entry into the setup.php file inside the routes folder.

                  
   $ php jollof make:route /home GET

Let's now create a simple controller file by running the command below.
This command will drop a Home.php file inside the routes folder.

NOTE: the name of the controller file MUST be the same as the first part of the route url.

   $ php jollof make:controller home

(Forgive any formatting; I'm on mobile.)

So, I'm thinking... Since the controller must be named same as route, why not have a command (or a flag to the route-generating command) that creates the controller file too? I believe he idea behind using commands like these is to simplify things by generating oft-used templates, not just to avoid clicking "New File".

[isocroft]

Oh! my bad. I'll correct that error in the EASYDOCS.md file.

Adding a flag to the route-generating command that creates the controller file

I think this's wouldn't be a bad idea. Using one stone to kill two birds. I'll look into this. Infact i'll implement it.

[isocroft]

So, now we have the following already implemented - set-controller serves as the flag to create the controller.

    $ php jollof make:route /api/contents/@id POST set-controller

@shalvah what do you think ?

[shalvah]

Not bad, but I think we could provide a single-letter flag too (my hand would be paining me with all that typing). Maybe `-c`? Also, don't forget the dashes normally used for flags.

…

On Tue, Jan 24, 2017, 13:32 Ifeora Okechukwu ***@***.***> wrote: So, now we have the following already implemented - *set-controller* serves as the flag to create the controller. $ php jollof make:route ***@***.*** POST set-controller @shalvah <https://github.com/shalvah> what do you think ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#10 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ANsh8RQBM9K7x6B8gwhY6huayN_U2IL7ks5rVe9TgaJpZM4LmPjO> .

[isocroft]

@shalvah, a single letter it is "-c". Will have it done soon

[isocroft]

@shalvah , I have already providered 2 alternatives '--controller', '-c'. One is a single-letter flag and the other is a full-option flag (long-option). Pushing v0.0.4 updates in an hours time from now.

[isocroft]

on the advice of a developer, who introduced me to https://semver.org, i actually re-versioned Jollof to begin from v0.0.2 (start) -> v0.0.4 (current)