search

chilts / blogz

Read a directory of files, get a blog data structure.
4 stars 3 forks source link

Improve documentation && add sensible defaults #3

Closed alessioalex closed 10 years ago

alessioalex commented 10 years ago

Except contentDir and domain (which are mandatory and we should throw an error if not present), the rest of the params should have defaults, such as:

opts = _.extend({
  base: '',
  latestCount: 10
}, opts);

Also we should improve the docs and explain what each param represents.