testing/xpcshell/node-http2/node_modules/http2-protocol/README.md@6474c204b198 (annotated)
testing/xpcshell/node-http2/node_modules/http2-protocol/README.md
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | node-http2-protocol |
| michael@0 | 2 | =================== |
| michael@0 | 3 | |
| michael@0 | 4 | An HTTP/2 ([draft-ietf-httpbis-http2-10](http://tools.ietf.org/html/draft-ietf-httpbis-http2-10)) |
| michael@0 | 5 | framing layer implementaion for node.js. |
| michael@0 | 6 | |
| michael@0 | 7 | Installation |
| michael@0 | 8 | ------------ |
| michael@0 | 9 | |
| michael@0 | 10 | ``` |
| michael@0 | 11 | npm install http2-protocol |
| michael@0 | 12 | ``` |
| michael@0 | 13 | |
| michael@0 | 14 | Examples |
| michael@0 | 15 | -------- |
| michael@0 | 16 | |
| michael@0 | 17 | API |
| michael@0 | 18 | --- |
| michael@0 | 19 | |
| michael@0 | 20 | Development |
| michael@0 | 21 | ----------- |
| michael@0 | 22 | |
| michael@0 | 23 | ### Development dependencies ### |
| michael@0 | 24 | |
| michael@0 | 25 | There's a few library you will need to have installed to do anything described in the following |
| michael@0 | 26 | sections. After installing/cloning node-http2, run `npm install` in its directory to install |
| michael@0 | 27 | development dependencies. |
| michael@0 | 28 | |
| michael@0 | 29 | Used libraries: |
| michael@0 | 30 | |
| michael@0 | 31 | * [mocha](http://visionmedia.github.io/mocha/) for tests |
| michael@0 | 32 | * [chai](http://chaijs.com/) for assertions |
| michael@0 | 33 | * [istanbul](https://github.com/gotwarlost/istanbul) for code coverage analysis |
| michael@0 | 34 | * [docco](http://jashkenas.github.io/docco/) for developer documentation |
| michael@0 | 35 | * [bunyan](https://github.com/trentm/node-bunyan) for logging |
| michael@0 | 36 | |
| michael@0 | 37 | For pretty printing logs, you will also need a global install of bunyan (`npm install -g bunyan`). |
| michael@0 | 38 | |
| michael@0 | 39 | ### Developer documentation ### |
| michael@0 | 40 | |
| michael@0 | 41 | The developer documentation is generated from the source code using docco and can be viewed online |
| michael@0 | 42 | [here](http://molnarg.github.io/node-http2-protocol/doc/). If you'd like to have an offline copy, |
| michael@0 | 43 | just run `npm run-script doc`. |
| michael@0 | 44 | |
| michael@0 | 45 | ### Running the tests ### |
| michael@0 | 46 | |
| michael@0 | 47 | It's easy, just run `npm test`. The tests are written in BDD style, so they are a good starting |
| michael@0 | 48 | point to understand the code. |
| michael@0 | 49 | |
| michael@0 | 50 | ### Test coverage ### |
| michael@0 | 51 | |
| michael@0 | 52 | To generate a code coverage report, run `npm test --coverage` (it may be slow, be patient). |
| michael@0 | 53 | Code coverage summary as of version 0.9.0: |
| michael@0 | 54 | ``` |
| michael@0 | 55 | Statements : 92.43% ( 1257/1360 ) |
| michael@0 | 56 | Branches : 86.36% ( 500/579 ) |
| michael@0 | 57 | Functions : 90.12% ( 146/162 ) |
| michael@0 | 58 | Lines : 92.39% ( 1251/1354 ) |
| michael@0 | 59 | ``` |
| michael@0 | 60 | |
| michael@0 | 61 | There's a hosted version of the detailed (line-by-line) coverage report |
| michael@0 | 62 | [here](http://molnarg.github.io/node-http2-protocol/coverage/lcov-report/lib/). |
| michael@0 | 63 | |
| michael@0 | 64 | ### Logging ### |
| michael@0 | 65 | |
| michael@0 | 66 | Contributors |
| michael@0 | 67 | ------------ |
| michael@0 | 68 | |
| michael@0 | 69 | Code contributions are always welcome! People who contributed to node-http2 so far: |
| michael@0 | 70 | |
| michael@0 | 71 | * Nick Hurley |
| michael@0 | 72 | * Mike Belshe |
| michael@0 | 73 | |
| michael@0 | 74 | Special thanks to Google for financing the development of this module as part of their [Summer of |
| michael@0 | 75 | Code program](https://developers.google.com/open-source/soc/) (project: [HTTP/2 prototype server |
| michael@0 | 76 | implementation](https://google-melange.appspot.com/gsoc/project/google/gsoc2013/molnarg/5001)), and |
| michael@0 | 77 | Nick Hurley of Mozilla, my GSoC mentor, who helped with regular code review and technical advices. |
| michael@0 | 78 | |
| michael@0 | 79 | License |
| michael@0 | 80 | ------- |
| michael@0 | 81 | |
| michael@0 | 82 | The MIT License |
| michael@0 | 83 | |
| michael@0 | 84 | Copyright (C) 2013 Gábor Molnár <gabor@molnar.es> |
