Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use hr markdown syntax in README #176

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use hr markdown syntax in README #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@

Skipper makes it easy to implement streaming file uploads to disk, S3, or any supported file upload adapters.

============================================

--------------------------------------------

## Quick Start

Expand All @@ -22,7 +21,7 @@ req.file('avatar').upload(function (err, uploadedFiles){
return res.send(200, uploadedFiles);
});
```
============================================
--------------------------------------------


## Installation
Expand All @@ -39,7 +38,7 @@ npm install skipper --save
app.use(require('skipper')());
```

============================================
--------------------------------------------


## Global options
Expand Down Expand Up @@ -71,7 +70,7 @@ req.file('avatar').upload(function (err, uploadedFiles) {
onProgress | ((function)) | Optional. This function will be called again and again as the upstream pumps chunks into the receiver with an object representing the current status of the upload, until the upload completes. Currently experimental.


============================================
--------------------------------------------


## Use Cases
Expand Down Expand Up @@ -213,7 +212,7 @@ It exposes the following adapter-specific options:


<!--
============================================
--------------------------------------------

#### Customizing at-rest filenames for uploads

Expand All @@ -237,7 +236,7 @@ It exposes the following adapter-specific options:
> TODO
-->

============================================
--------------------------------------------


## Background
Expand Down Expand Up @@ -435,7 +434,7 @@ The most important method is `receive()` -- it builds the upstream receiver whic
-->


============================================
--------------------------------------------


## Low-Level Usage
Expand Down Expand Up @@ -603,7 +602,7 @@ var upstream = req.file('foo').upload({
```


============================================
--------------------------------------------


## Status
Expand All @@ -612,7 +611,7 @@ This module is published on npm. Development takes place on the `master` branch

See [ROADMAP.md](./ROADMAP.md) for more information on where the project is headed and how you can contribute.

============================================
--------------------------------------------

## More Resources

Expand All @@ -624,7 +623,7 @@ See [ROADMAP.md](./ROADMAP.md) for more information on where the project is head
- [Facebook](https://www.facebook.com/sailsjs)
- <a href="http://sailsjs.org" target="_blank" title="Node.js framework for building realtime APIs."><img src="http://sailsjs.org/images/logos/sails-logo_ltBg_dkBlue.png" width=60 alt="Sails.js logo (small)"/></a>

============================================
--------------------------------------------

## License

Expand Down