The information the README.txt file is very useful. But it would be easier and less overwhelming if some of that information was taken out and put into a site/page that displays the detailed code examples.

I would think have an Installation and Configuration area in the readme, and then a link to the detailed documentation would make things much more easy to go through.

Another idea that may be worth creating a new issue about, is to include an examples directory that has some functions that go through different ways in using the module. You could extend what you already did in the README.txt file.

Comments

sbrattla’s picture

sbrattla commented
Version: » 7.x-1.x-dev
Assigned: Unassigned » sbrattla
Status: Active » Fixed

Hi,

A documentation section has now been added. It basically contains the same information as you'll find in the README.txt file, but things are formatted a bit nicer. It is a good idea to provide some examples/scenarios/use cases which can shed a little light on what the module is good for. I'll create a separate issue for that.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.