mde/jake — Issue #97: clearer documentation of NPMPublishTask
Author: benatkin
Created: 2012-02-08 00:42:38+00:00
State: open

In the README it says that NPMPublishTask adds a publish task but it doesn't say how. How about changing:

```The NpmPublishTask will automatically create a publish task which performs the following steps:```

to:

```The NpmPublishTask constructor will automatically create a publish task which performs the following steps:```

Since more is going on than constructing I think it would be a good idea to have another way besides constructing it and thus remove the unnecessary variable without having the bare constructor which many find distracting. This could be backward-compatible. How about `jake.package()' or 'jake.publish_task`?

Another thing: since the primary place to read the README is GitHub, and most programmers prefer syntax highlighting, how about [fencing the code blocks](http://github.github.com/github-flavored-markdown/)?