Permalink
Browse files

fix readme

  • Loading branch information...
1 parent 08826f6 commit 09b403f337d6d9826c10d806c7d60a5eac297765 @tih-ra committed Nov 28, 2011
Showing with 5 additions and 1 deletion.
  1. +5 −1 README.md
View
@@ -9,6 +9,7 @@ Flexible way to resize and upload images to Amazon S3 or file system storages fo
## Quick Start
1. **You need to create alleup configuration file with image variants and your storages**
+
Example:
```javascript
@@ -44,6 +45,7 @@ Example:
You can use `storage: 'aws'` for store files on Amazon S3 or `storage: 'dir'` for store files in filesystem
**Upload example**
+
```javascript
app.post('/upload', function(req, res) {
alleup.upload(req, res, function(err, file, res){
@@ -55,6 +57,7 @@ You can use `storage: 'aws'` for store files on Amazon S3 or `storage: 'dir'` fo
});
**Get file url example**
+
```javascript
alleup.url(file, variant)
`file` - The name of the file you uploaded, saved for example in database (`345621345.jpg`), `variant` - one of your image variants names from alleup_congig.json
@@ -69,7 +72,8 @@ You can use `storage: 'aws'` for store files on Amazon S3 or `storage: 'dir'` fo
};
### Contribution
-Pull requests are welcome!!!
+**Pull requests are welcome!!!**
+
### License
(The MIT License)

0 comments on commit 09b403f

Please sign in to comment.