vendor/phpseclib/phpseclib/README.md

   1 # phpseclib - PHP Secure Communications Library
   2
   3 [![Build Status](https://travis-ci.org/phpseclib/phpseclib.svg?branch=2.0)](https://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 * [Browse Git](https://github.com/phpseclib/phpseclib)
  10 * [Code Coverage Report](https://coverage.phpseclib.org/2.0/latest/)
  11
  12 ## Documentation
  13
  14 * [Documentation / Manual](http://phpseclib.sourceforge.net/)
  15 * [API Documentation](https://api.phpseclib.org/2.0/) (generated by Sami)
  16
  17 ## Branches
  18
  19 ### master
  20
  21 * Development Branch
  22 * Unstable API
  23 * Do not use in production
  24
  25 ### 2.0
  26
  27 * Long term support (LTS) release
  28 * Modernized version of 1.0
  29 * Minimum PHP version: 5.3.3
  30 * PSR-4 autoloading with namespace rooted at `\phpseclib`
  31 * Install via Composer: `composer require phpseclib/phpseclib ~2.0`
  32
  33 ### 1.0
  34
  35 * Long term support (LTS) release
  36 * PHP4 compatible
  37 * Composer compatible (PSR-0 autoloading)
  38 * Install using Composer: `composer require phpseclib/phpseclib ~1.0`
  39 * Install using PEAR: See [phpseclib PEAR Channel Documentation](http://phpseclib.sourceforge.net/pear.htm)
  40 * [Download 1.0.16 as ZIP](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.16.zip/download)
  41
  42 ## Support
  43
  44 Need Support?
  45
  46 * [Checkout Questions and Answers on Stack Overflow](http://stackoverflow.com/questions/tagged/phpseclib)
  47 * [Create a Support Ticket on GitHub](https://github.com/phpseclib/phpseclib/issues/new)
  48 * [Browse the Support Forum](http://www.frostjedi.com/phpbb/viewforum.php?f=46) (no longer in use)
  49
  50 ## Contributing
  51
  52 1. Fork the Project
  53
  54 2. Ensure you have Composer installed (see [Composer Download Instructions](https://getcomposer.org/download/))
  55
  56 3. Install Development Dependencies
  57
  58     ``` sh
  59     composer install
  60     ```
  61
  62 4. Create a Feature Branch
  63
  64 5. (Recommended) Run the Test Suite
  65
  66     ``` sh
  67     vendor/bin/phpunit
  68     ```
  69 6. (Recommended) Check whether your code conforms to our Coding Standards by running
  70
  71     ``` sh
  72     vendor/bin/phing -f build/build.xml sniff
  73     ```
  74
  75 7. Send us a Pull Request