michael@0: node-http2-protocol
michael@0: ===================
michael@0: 
michael@0: An HTTP/2 ([draft-ietf-httpbis-http2-10](http://tools.ietf.org/html/draft-ietf-httpbis-http2-10))
michael@0: framing layer implementaion for node.js.
michael@0: 
michael@0: Installation
michael@0: ------------
michael@0: 
michael@0: ```
michael@0: npm install http2-protocol
michael@0: ```
michael@0: 
michael@0: Examples
michael@0: --------
michael@0: 
michael@0: API
michael@0: ---
michael@0: 
michael@0: Development
michael@0: -----------
michael@0: 
michael@0: ### Development dependencies ###
michael@0: 
michael@0: There's a few library you will need to have installed to do anything described in the following
michael@0: sections. After installing/cloning node-http2, run `npm install` in its directory to install
michael@0: development dependencies.
michael@0: 
michael@0: Used libraries:
michael@0: 
michael@0: * [mocha](http://visionmedia.github.io/mocha/) for tests
michael@0: * [chai](http://chaijs.com/) for assertions
michael@0: * [istanbul](https://github.com/gotwarlost/istanbul) for code coverage analysis
michael@0: * [docco](http://jashkenas.github.io/docco/) for developer documentation
michael@0: * [bunyan](https://github.com/trentm/node-bunyan) for logging
michael@0: 
michael@0: For pretty printing logs, you will also need a global install of bunyan (`npm install -g bunyan`).
michael@0: 
michael@0: ### Developer documentation ###
michael@0: 
michael@0: The developer documentation is generated from the source code using docco and can be viewed online
michael@0: [here](http://molnarg.github.io/node-http2-protocol/doc/). If you'd like to have an offline copy,
michael@0: just run `npm run-script doc`.
michael@0: 
michael@0: ### Running the tests ###
michael@0: 
michael@0: It's easy, just run `npm test`. The tests are written in BDD style, so they are a good starting
michael@0: point to understand the code.
michael@0: 
michael@0: ### Test coverage ###
michael@0: 
michael@0: To generate a code coverage report, run `npm test --coverage` (it may be slow, be patient).
michael@0: Code coverage summary as of version 0.9.0:
michael@0: ```
michael@0: Statements   : 92.43% ( 1257/1360 )
michael@0: Branches     : 86.36% ( 500/579 )
michael@0: Functions    : 90.12% ( 146/162 )
michael@0: Lines        : 92.39% ( 1251/1354 )
michael@0: ```
michael@0: 
michael@0: There's a hosted version of the detailed (line-by-line) coverage report
michael@0: [here](http://molnarg.github.io/node-http2-protocol/coverage/lcov-report/lib/).
michael@0: 
michael@0: ### Logging ###
michael@0: 
michael@0: Contributors
michael@0: ------------
michael@0: 
michael@0: Code contributions are always welcome! People who contributed to node-http2 so far:
michael@0: 
michael@0: * Nick Hurley
michael@0: * Mike Belshe
michael@0: 
michael@0: Special thanks to Google for financing the development of this module as part of their [Summer of
michael@0: Code program](https://developers.google.com/open-source/soc/) (project: [HTTP/2 prototype server
michael@0: implementation](https://google-melange.appspot.com/gsoc/project/google/gsoc2013/molnarg/5001)), and
michael@0: Nick Hurley of Mozilla, my GSoC mentor, who helped with regular code review and technical advices.
michael@0: 
michael@0: License
michael@0: -------
michael@0: 
michael@0: The MIT License
michael@0: 
michael@0: Copyright (C) 2013 Gábor Molnár <gabor@molnar.es>