securemail/vendor/phpseclib/phpseclib/README.md

   1 # phpseclib - PHP Secure Communications Library
   2
   3 [![Build Status](https://secure.travis-ci.org/phpseclib/phpseclib.png?branch=master)](http://travis-ci.org/phpseclib/phpseclib)
   4
   5 MIT-licensed pure-PHP implementations of an arbitrary-precision integer
   6 arithmetic library, fully PKCS#1 (v2.1) compliant RSA, DES, 3DES, RC4, Rijndael,
   7 AES, Blowfish, Twofish, SSH-1, SSH-2, SFTP, and X.509
   8
   9 * [Download (0.3.9)](http://sourceforge.net/projects/phpseclib/files/phpseclib0.3.9.zip/download)
  10 * [Browse Git](https://github.com/phpseclib/phpseclib)
  11 * [Code Coverage Report](http://phpseclib.bantux.org/code_coverage/master/latest/)
  12
  13 <img src="http://phpseclib.sourceforge.net/pear-icon.png" alt="PEAR Channel" width="16" height="16">
  14 PEAR Channel: [phpseclib.sourceforge.net](http://phpseclib.sourceforge.net/pear.htm)
  15
  16 ## Documentation
  17
  18 * [Documentation / Manual](http://phpseclib.sourceforge.net/)
  19 * [API Documentation](http://phpseclib.bantux.org/api/master/) (generated by Sami)
  20
  21 ## Support
  22
  23 Need Support?
  24
  25 * [Checkout Questions and Answers on Stack Overflow](http://stackoverflow.com/questions/tagged/phpseclib)
  26 * [Create a Support Ticket on GitHub](https://github.com/phpseclib/phpseclib/issues/new)
  27 * [Browse the Support Forum](http://www.frostjedi.com/phpbb/viewforum.php?f=46) (no longer in use)
  28
  29 ## Installing Development Dependencies
  30
  31 Dependencies are managed via Composer.
  32
  33 1. Download the [`composer.phar`](https://getcomposer.org/composer.phar) executable as per the
  34    [Composer Download Instructions](https://getcomposer.org/download/), e.g. by running
  35
  36     ``` sh
  37     curl -sS https://getcomposer.org/installer | php
  38     ```
  39
  40 2. Install Dependencies
  41
  42     ``` sh
  43     php composer.phar install --dev
  44     ```
  45
  46 ## Contributing
  47
  48 1. Fork the Project
  49
  50 2. Install Development Dependencies
  51
  52 3. Create a Feature Branch
  53
  54 4. (Recommended) Run the Test Suite
  55
  56     ``` sh
  57     vendor/bin/phpunit
  58     ```
  59 5. (Recommended) Check whether your code conforms to our Coding Standards by running
  60
  61     ``` sh
  62     vendor/bin/phing -f build/build.xml sniff
  63     ```
  64
  65 6. Send us a Pull Request