Skip to content

Commit

Permalink
update readme with config syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
joshrowley committed Jul 16, 2014
1 parent b37165b commit 1fac234
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,31 +48,31 @@ Take a look at [`cms.json.example`](/cms.json.example) to get a good overview of
}
```

**uploader:** Choose which file uploader to use for uploading images to the project. Use `"fs"` to upload directly into the `assets/img` directory into your roots project. Use `"s3"` for uploading images to Amazon S3 (you'll need to set `aws` in your config as well)
**uploader:** Choose which file uploader adapter to use for uploading images to the project. Defaults to uploading to the roots project's file system. Specify the `adapter`, each adapter will have additional options that can be passed in.

FS uploader config:

```json
{ "uploader": "fs" }
{
"uploader": {
"adapter": "fs",
"dir": "assets/img/uploads"
}
}
```

**aws:** An object with `key`, `secret`, and `bucket` key value pairs. Used to configure the Amazon S3 client.
S3 uploader config:

```json
{
"uploader": "s3",
"aws": {
"uploader": {
"adapter": "s3",
"key": "XXX",
"secret": "XXX",
"bucket": "bucket-name"
}
}
```

**img_upload_dir:** The directory prefix to use for all uploaded images, defaults to `uploads`.

```json
{ "img_upload_dir": "uploads" }
```

**templates:** You can pass an object with key-value pairs to a jade template in your roots project that Roots-CMS will attempt to compile and use those templates for its Marionette views. Use this to customize the markup for the Roots-CMS front-end. Right now the only template you can override is `content_edit`.

```json
Expand Down

0 comments on commit 1fac234

Please sign in to comment.