Boilerplate

.gitignore

@@ -0,0 +1,51 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.a
+*.o
+*.so
+*.node
+
+# Node Waf Byproducts #
+#######################
+.lock-wscript
+build/
+autom4te.cache/
+
+# Node Modules #
+################
+# Better to let npm install these from the package.json defintion
+# rather than maintain this manually
+node_modules/
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+dump.rdb
+*.tap
+*.xml
+coverage/
+
+# OS generated files #
+######################
+.DS_Store?
+.DS_Store
+ehthumbs.db
+Icon?
+Thumbs.db

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "0.10"
+before_install: npm i npm@latest -g
+script: npm run travis

CONTRIBUTION.md

@@ -0,0 +1,34 @@
+# Want to contribute?
+
+Great! That's why this is an open source project. We use this project in our infrastructure at Uber, and we hope that it's useful to others as well.
+
+Before you get started, here are some suggestions:
+
+ - Check open issues for what you want.
+ - If there is an open issue, comment on it. Otherwise open an issue describing your bug or feature with use cases.
+ - Before undertaking a major change, please discuss this on the issue. We'd hate to see you spend a lot of time working on something that conflicts with other goals or requirements that might not be obvious.
+ - Write code to fix the problem, then open a pull request with tests and documentation.
+ - The pull requests gets reviewed and then merged assuming there are no problems.
+ - A new release version gets cut.
+
+## Licencing
+
+ - Every file must have a licence block at the top. This is enforced using `uber-licence`
+ - If you contribute to a file in this project and are not an Uber employee, then you should
+add your name to the copyright section of the licence file.
+ - Work that you contribute must be your own.
+
+## Releases
+
+Declaring formal releases requires peer review.
+
+ - A reviewer of a pull request should recommend a new version number (patch, minor or major).
+ - Once your change is merged feel free to bump the version as recommended by the reviewer.
+ - A new version number should not be cut without peer review unless done by the project maintainer.
+
+### Cutting a new version
+
+ - Get your branch merged on master
+ - Run `npm version major` or `npm version minor` or `npm version patch`
+ - `git push origin master --tags`
+ - If you are a project owner, then `npm publish`

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Uber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MIGRATION.md

@@ -0,0 +1,11 @@
+# Migration
+
+Below you will find documentation on how to migrate from older
+versions of this module to newer versions.
+
+This document only describes what breaks and how to update your
+code.
+
+<!--
+# Upgrading from v1 to v2
+-->

README.md

@@ -1,3 +1,46 @@
 # tcap
 
+<!--
+    [![build status][build-png]][build]
+    [![Coverage Status][cover-png]][cover]
+    [![Davis Dependency status][dep-png]][dep]
+-->
+
+<!-- [![NPM][npm-png]][npm] -->
+
 Uses pcap to inspect tchannel traffic over a network interface.
+
+## Installation
+
+`npm install tcap -g`
+
+## Tests
+
+`npm test`
+
+## NPM scripts
+
+ - `npm run add-licence` This will add the licence headers.
+ - `npm run cover` This runs the tests with code coverage
+ - `npm run lint` This will run the linter on your code
+ - `npm test` This will run the tests.
+ - `npm run trace` This will run your tests in tracing mode.
+ - `npm run travis` This is run by travis.CI to run your tests
+ - `npm run view-cover` This will show code coverage in a browser
+
+## Contributors
+
+ - kriskowal
+
+## MIT Licenced
+
+  [build-png]: https://secure.travis-ci.org/uber/tcap.png
+  [build]: https://travis-ci.org/uber/tcap
+  [cover-png]: https://coveralls.io/repos/uber/tcap/badge.png
+  [cover]: https://coveralls.io/r/uber/tcap
+  [dep-png]: https://david-dm.org/uber/tcap.png
+  [dep]: https://david-dm.org/uber/tcap
+  [test-png]: https://ci.testling.com/uber/tcap.png
+  [tes]: https://ci.testling.com/uber/tcap
+  [npm-png]: https://nodei.co/npm/tcap.png?stars&downloads
+  [npm]: https://nodei.co/npm/tcap