Skip to content
This repository has been archived by the owner on Mar 6, 2019. It is now read-only.

Commit

Permalink
Document defaults. Fixes #2
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcw committed Jan 21, 2015
1 parent e925b24 commit 2211ebc
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# metalsmith-assets

Include static assets in your Metalsmith build
Expand All @@ -9,7 +8,7 @@

## CLI Usage

Install via npm and then add the `metalsmith-assets` key to your `metalsmith.json` plugins with a source and destination directory, like so:
Install via npm and then add the `metalsmith-assets` key to your `metalsmith.json` plugins with a source and destination directory, like so:

```json
{
Expand All @@ -22,6 +21,9 @@
}
```

* `source` defaults to `'./public'`
* `destination` defaults to `'.'`

## Javascript Usage

Pass `options` to the assets plugin and pass it to Metalsmith with the `use` method:
Expand Down

0 comments on commit 2211ebc

Please sign in to comment.