1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/testing/xpcshell/node-http2/node_modules/http2-protocol/README.md Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,84 @@
1.4 +node-http2-protocol
1.5 +===================
1.6 +
1.7 +An HTTP/2 ([draft-ietf-httpbis-http2-10](http://tools.ietf.org/html/draft-ietf-httpbis-http2-10))
1.8 +framing layer implementaion for node.js.
1.9 +
1.10 +Installation
1.11 +------------
1.12 +
1.13 +```
1.14 +npm install http2-protocol
1.15 +```
1.16 +
1.17 +Examples
1.18 +--------
1.19 +
1.20 +API
1.21 +---
1.22 +
1.23 +Development
1.24 +-----------
1.25 +
1.26 +### Development dependencies ###
1.27 +
1.28 +There's a few library you will need to have installed to do anything described in the following
1.29 +sections. After installing/cloning node-http2, run `npm install` in its directory to install
1.30 +development dependencies.
1.31 +
1.32 +Used libraries:
1.33 +
1.34 +* [mocha](http://visionmedia.github.io/mocha/) for tests
1.35 +* [chai](http://chaijs.com/) for assertions
1.36 +* [istanbul](https://github.com/gotwarlost/istanbul) for code coverage analysis
1.37 +* [docco](http://jashkenas.github.io/docco/) for developer documentation
1.38 +* [bunyan](https://github.com/trentm/node-bunyan) for logging
1.39 +
1.40 +For pretty printing logs, you will also need a global install of bunyan (`npm install -g bunyan`).
1.41 +
1.42 +### Developer documentation ###
1.43 +
1.44 +The developer documentation is generated from the source code using docco and can be viewed online
1.45 +[here](http://molnarg.github.io/node-http2-protocol/doc/). If you'd like to have an offline copy,
1.46 +just run `npm run-script doc`.
1.47 +
1.48 +### Running the tests ###
1.49 +
1.50 +It's easy, just run `npm test`. The tests are written in BDD style, so they are a good starting
1.51 +point to understand the code.
1.52 +
1.53 +### Test coverage ###
1.54 +
1.55 +To generate a code coverage report, run `npm test --coverage` (it may be slow, be patient).
1.56 +Code coverage summary as of version 0.9.0:
1.57 +```
1.58 +Statements : 92.43% ( 1257/1360 )
1.59 +Branches : 86.36% ( 500/579 )
1.60 +Functions : 90.12% ( 146/162 )
1.61 +Lines : 92.39% ( 1251/1354 )
1.62 +```
1.63 +
1.64 +There's a hosted version of the detailed (line-by-line) coverage report
1.65 +[here](http://molnarg.github.io/node-http2-protocol/coverage/lcov-report/lib/).
1.66 +
1.67 +### Logging ###
1.68 +
1.69 +Contributors
1.70 +------------
1.71 +
1.72 +Code contributions are always welcome! People who contributed to node-http2 so far:
1.73 +
1.74 +* Nick Hurley
1.75 +* Mike Belshe
1.76 +
1.77 +Special thanks to Google for financing the development of this module as part of their [Summer of
1.78 +Code program](https://developers.google.com/open-source/soc/) (project: [HTTP/2 prototype server
1.79 +implementation](https://google-melange.appspot.com/gsoc/project/google/gsoc2013/molnarg/5001)), and
1.80 +Nick Hurley of Mozilla, my GSoC mentor, who helped with regular code review and technical advices.
1.81 +
1.82 +License
1.83 +-------
1.84 +
1.85 +The MIT License
1.86 +
1.87 +Copyright (C) 2013 Gábor Molnár <gabor@molnar.es>
