The Tor Browser: testing/xpcshell/node-http2/node_modules/http2-protocol/README.md@6474c204b198

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

     1 node-http2-protocol

     2 ===================

     4 An HTTP/2 ([draft-ietf-httpbis-http2-10](http://tools.ietf.org/html/draft-ietf-httpbis-http2-10))

     5 framing layer implementaion for node.js.

     7 Installation

     8 ------------

    10 ```

    11 npm install http2-protocol

    12 ```

    14 Examples

    15 --------

    17 API

    18 ---

    20 Development

    21 -----------

    23 ### Development dependencies ###

    25 There's a few library you will need to have installed to do anything described in the following

    26 sections. After installing/cloning node-http2, run `npm install` in its directory to install

    27 development dependencies.

    29 Used libraries:

    31 * [mocha](http://visionmedia.github.io/mocha/) for tests

    32 * [chai](http://chaijs.com/) for assertions

    33 * [istanbul](https://github.com/gotwarlost/istanbul) for code coverage analysis

    34 * [docco](http://jashkenas.github.io/docco/) for developer documentation

    35 * [bunyan](https://github.com/trentm/node-bunyan) for logging

    37 For pretty printing logs, you will also need a global install of bunyan (`npm install -g bunyan`).

    39 ### Developer documentation ###

    41 The developer documentation is generated from the source code using docco and can be viewed online

    42 [here](http://molnarg.github.io/node-http2-protocol/doc/). If you'd like to have an offline copy,

    43 just run `npm run-script doc`.

    45 ### Running the tests ###

    47 It's easy, just run `npm test`. The tests are written in BDD style, so they are a good starting

    48 point to understand the code.

    50 ### Test coverage ###

    52 To generate a code coverage report, run `npm test --coverage` (it may be slow, be patient).

    53 Code coverage summary as of version 0.9.0:

    54 ```

    55 Statements   : 92.43% ( 1257/1360 )

    56 Branches     : 86.36% ( 500/579 )

    57 Functions    : 90.12% ( 146/162 )

    58 Lines        : 92.39% ( 1251/1354 )

    59 ```

    61 There's a hosted version of the detailed (line-by-line) coverage report

    62 [here](http://molnarg.github.io/node-http2-protocol/coverage/lcov-report/lib/).

    64 ### Logging ###

    66 Contributors

    67 ------------

    69 Code contributions are always welcome! People who contributed to node-http2 so far:

    71 * Nick Hurley

    72 * Mike Belshe

    74 Special thanks to Google for financing the development of this module as part of their [Summer of

    75 Code program](https://developers.google.com/open-source/soc/) (project: [HTTP/2 prototype server

    76 implementation](https://google-melange.appspot.com/gsoc/project/google/gsoc2013/molnarg/5001)), and

    77 Nick Hurley of Mozilla, my GSoC mentor, who helped with regular code review and technical advices.

    79 License

    80 -------

    82 The MIT License

    84 Copyright (C) 2013 Gábor Molnár <gabor@molnar.es>

The Tor Browser / file revision