Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Commit 742b1bc

Browse files
author
Adam Kliment
committed
Updated readme with simple example
1 parent ea98872 commit 742b1bc

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ The only glitch is that cURL `--trace` saves data in [its custom format][gist],
1414

1515
[gist]: https://gist.github.com/netmilk/6048533
1616

17+
## Usage
18+
19+
```
20+
$ curl --trace - http://httpbin.org/ip | curl-trace-parser
21+
```
22+
1723
## Example
1824

1925
We will be using this [sample API][apiarydoc] created with the [Apiary.io mock server](http://apiary.io) to demonstrate tracing an HTTP communication and the use of the cURL trace parser.
@@ -92,5 +98,11 @@ fs.readFile('./tracefile', 'utf8', function (err,trace) {
9298
})
9399
```
94100
101+
## API Reference
102+
103+
`parse(traceString)`
104+
105+
``
106+
95107
[message]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html
96108

0 commit comments

Comments
 (0)