document ignore/exclude option about gulp-typedoc

[rogierschouten]

Hi @ORESoftware, thank you for creating this issue here. Whether ignore or exclude does the job, is up to typedoc. According to https://github.com/TypeStrong/typedoc it should be 'exclude'. The only thing that gulp-typedoc does is to pass on whatever arguments you happen to give. I'm a bit careful with what I show in the readme because different versions of typedoc have different sets of possible arguments, hence what you tried now may not work with every version of typedoc. Really people should be looking at http://typedoc.org/ for possible arguments.

If you feel you can make the readme more clear in this respect, I'm more than happy to merge a PR.

[ORESoftware]

I think it would be great if the readme file has the exclude option demonstrated. The reason why it's ambiguous, even for someone with a few years of Node.js experience, is that I don't know if the options used by your lib are Gulp flavored or Typedoc flavored. In fact, initially I expected the options to be Gulp flavored, that's why I was unsure.

I think for README files, 90% of the time it's best to do this:

1. put a simple case with the most commonly used options.

2. put in an exhaustive case with all of the current options.

So maybe put an example with all options, including exclude.

[rogierschouten]

I'm closing this because you didn't submit a PR. Please feel free to still do so though.