Permalink
Browse files

More docs.

  • Loading branch information...
1 parent 5b73737 commit c8e22b44bf1f4dcc04d9f29f3835da1bb3e6fd51 @cowboy committed Mar 19, 2012
Showing with 3 additions and 3 deletions.
  1. +3 −3 docs/api.md
View
6 docs/api.md
@@ -2,17 +2,17 @@
# The grunt API
-Grunt exposes all of its methods and properties on the `grunt` object which is passed into the function defined in your [config.js gruntfile](configuring.md) or [tasks file](tasks_creating.md).
+Grunt exposes all of its methods and properties on the `grunt` object that gets passed into the `exports.config` function exported in your [config.js gruntfile](configuring.md) or the `exports.tasks` function exported in your [tasks file](tasks_creating.md).
-In a [gruntfile](configuring.md):
+For example, your [config.js gruntfile](configuring.md) might look like this:
```javascript
exports.config = function(grunt) {
// Initialize configuration object, define tasks and helpers (etc) here...
};
```
-In a [custom tasks file](tasks_creating.md):
+And if you're creating a [grunt plugin](plugins.md) or just organizing tasks into a folder, a [custom tasks file](tasks_creating.md) might look like this:
```javascript
exports.tasks = function(grunt) {

0 comments on commit c8e22b4

Please sign in to comment.