Permalink
Browse files

readme fix

  • Loading branch information...
Ryan French
Ryan French committed Mar 28, 2012
1 parent 9806aea commit cf11dab64d7dc22f9a36f5ccaeb0b9df1f88e5b4
Showing with 5 additions and 12 deletions.
  1. +5 −12 README.md
View
@@ -3,20 +3,13 @@ Async node module for uploading local/remote files over multipart.
## Install
<pre>
- npm install poster
+ $ npm install poster
</pre>
-Or from source:
+## post(uri, options, callback[err, data])
-<pre>
- git clone git://github.com/rfrench/poster.git
- cd poster
- npm link
-</pre>
-
-## post(url, options, callback[err, data])
-
- - `uploadUrl`: Whether to follow redirects or not. Can be a number (of max redirects), `true` (which translates to 20) or `false` (default).
+### Options
+ - `uploadUrl`: Upload URL. (required)
- `method`: HTTP method type. Defaults to `POST`.
- `fileId`: File ID parameter name of the file. Defaults to `Filedata`.
- `fields`: Optional form parameters.
@@ -72,7 +65,7 @@ poster.post('https://www.google.com/logos/2012/addams11-hp.jpg', options, functi
## BYOA (Bring Your Own Agent)
<pre>
- npm install tunnel
+ $ npm install tunnel
</pre>
``` js

0 comments on commit cf11dab

Please sign in to comment.