Document the package in the readme.

4teamwork / ftw.builder

Builder pattern for creating Plone objects in tests

3 stars 0 forks source link

Document the package in the readme. #5

Closed jone closed 11 years ago

jone commented 11 years ago

I've started to write a readme.

Not sure how to describe the intent of the package in a good way

@senny @phgross

Closes #2 Includes documentation for #4

jone commented 11 years ago

[x] Update doc for sessions (#4 )

jone commented 11 years ago

I've updated the readme, @senny can you take a look?

jone commented 11 years ago

@senny If added a Quick start heading.. Should it be Quick start or Usage? The rest of the readme is also kind of usage, I think...

senny commented 11 years ago

I like Usage better but it's a personal preference.

senny commented 11 years ago

no need to have different Usage sections. We should write them in a way that the "Quick Start" information is first, followed by deeper knowledge about the package.