Skip to content

Commit 5f09155

Browse files
committed
Update README.md
1 parent 6ba4404 commit 5f09155

1 file changed

Lines changed: 35 additions & 24 deletions

File tree

README.md

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,50 @@
1-
What is it?
2-
===========
1+
# Http Multipart Parser
2+
3+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://httpmultipartparser.mit-license.org/)
4+
![Sourcelink](https://img.shields.io/badge/sourcelink-enabled-brightgreen.svg)
5+
[![Build status](https://ci.appveyor.com/api/projects/status/t547jmcf10s53h2u?svg=true)](https://ci.appveyor.com/project/Jericho/http-multipart-data-parser)
6+
![tests](https://img.shields.io/appveyor/tests/jericho/http-multipart-data-parser)
7+
8+
[![Coverage Status](https://coveralls.io/repos/github/Http-Multipart-Data-Parser/Http-Multipart-Data-Parser/badge.svg?branch=master)](https://coveralls.io/github/Http-Multipart-Data-Parser/Http-Multipart-Data-Parser?branch=master)
9+
[![CodeFactor](https://www.codefactor.io/repository/github/http-multipart-data-parser/http-multipart-data-parser/badge)](https://www.codefactor.io/repository/github/http-multipart-data-parser/http-multipart-data-parser)
10+
11+
| Release Notes| NuGet (stable) | MyGet (prerelease) |
12+
|--------------|----------------|--------------------|
13+
| [![GitHub release](https://img.shields.io/github/release/jericho/http-multipart-data-parser.svg)](https://github.com/http-multipart-data-parser/http-multipart-data-parser/releases) | [![NuGet Version](http://img.shields.io/nuget/v/HttpMultipartDataParser.svg)](https://www.nuget.org/packages/HttpMultipartParser/) | [![MyGet Pre Release](https://img.shields.io/myget/jericho/vpre/HttpMultipartParser.svg)](http://myget.org/gallery/jericho) |
14+
15+
## About
316

417
The Http Multipart Parser does it exactly what it claims on the tin: parses multipart/form-data. This particular
518
parser is well suited to parsing large data from streams as it doesn't attempt to read the entire stream at once and
619
procudes a set of streams for file data.
720

8-
Installation
9-
=============
10-
Simply add the HttpMultipartParser project to your solution and reference it in the projects you want to use it in.
21+
## Installation
1122

12-
There is also a NuGet package provided.
23+
The easiest way to include HttpMultipartParser in your project is by adding the nuget package to your project:
1324

14-
Dependencies
15-
============
16-
The parser was built for and tested on NET 4.0. Versions lower then this may work but are untested.
25+
```
26+
PM> Install-Package HttpMultipartParser
27+
```
1728

18-
How do I use it?
19-
================
20-
## Non-Streaming (Simple, don't use on very large files)
21-
1. Create a new MultipartFormDataParser with the stream containing the multipart/form-data.
29+
## .NET framework suport
30+
31+
The parser was built for and tested on NET 4.6.1, NET 4,7,2 and NETSTANDARD 2.0. Versions 2.2.4 was the last version of HttpMultipartParser that supported older .NET platforms such as NET 4.5 and NETSTANDARD 1.3.
32+
33+
## Usage
34+
35+
### Non-Streaming (Simple, don't use on very large files)
36+
1. Parse the stream containing the multipart/form-data by invoking `MultipartFormDataParser.Parse` (or it's asynchronous counterpart `MultipartFormDataParser.ParseAsync`).
2237
2. Access the data through the parser.
2338

2439
## Streaming (Handles large files)
2540
1. Create a new StreamingMultipartFormDataParser with the stream containing the multipart/form-data
2641
2. Set up the ParameterHandler and FileHandler delegates
27-
3. Call parser.Run()
42+
3. Call `parser.Run()` (or it's asynchronous counterpart `parser.RunAsync()`)
2843
4. The delegates will be called as data streams in.
2944

30-
Examples
31-
========
45+
## Examples
3246

33-
Single file
34-
-----------
47+
### Single file
3548

3649
// stream:
3750
-----------------------------41952539122868
@@ -81,8 +94,7 @@ Single file
8194
// Or you can parse asynchronously:
8295
await parser.RunAsync().ConfigureAwait(false);
8396

84-
Multiple Parameters
85-
-------------------
97+
### Multiple Parameters
8698

8799
// stream:
88100
-----------------------------41952539122868
@@ -110,8 +122,7 @@ Multiple Parameters
110122
Console.WriteLine("Parameter {0} is {1}", parameter.Name, parameter.Data)
111123
}
112124

113-
Multiple Files
114-
-----------
125+
### Multiple Files
115126

116127
// stream:
117128
-----------------------------41111539122868
@@ -162,6 +173,6 @@ Multiple Files
162173
// Or you can parse asynchronously:
163174
await parser.RunAsync().ConfigureAwait(false);
164175

165-
Licensing
166-
=========
176+
## Licensing
177+
167178
This project is licensed under MIT.

0 commit comments

Comments
 (0)