phpseclib/README.md

# phpseclib - PHP Secure Communications Library

[![Build Status](https://travis-ci.org/phpseclib/phpseclib.svg?branch=master)](https://travis-ci.org/phpseclib/phpseclib)

MIT-licensed pure-PHP implementations of an arbitrary-precision integer
arithmetic library, fully PKCS#1 (v2.1) compliant RSA, DES, 3DES, RC4, Rijndael,
AES, Blowfish, Twofish, SSH-1, SSH-2, SFTP, and X.509

* [Browse Git](https://github.com/phpseclib/phpseclib)
* [Code Coverage Report](https://coverage.phpseclib.org/master/latest/)
* Support phpseclib development by [![Becoming a patron](https://img.shields.io/badge/become-patron-brightgreen.svg)](https://www.patreon.com/phpseclib)

## Documentation

* [Documentation / Manual](http://phpseclib.sourceforge.net/)
* [API Documentation](https://api.phpseclib.org/master/) (generated by Sami)

## Branches

### master

* Development Branch
* Unstable API
* Do not use in production

### 2.0

* Modernized version of 1.0
* Minimum PHP version: 5.3.3
* PSR-4 autoloading with namespace rooted at `\phpseclib`
* Install via Composer: `composer require phpseclib/phpseclib ~2.0`

### 1.0

* Long term support (LTS) release
* PHP4 compatible
* Composer compatible (PSR-0 autoloading)
* Install using Composer: `composer require phpseclib/phpseclib ~1.0`
* Install using PEAR: See [phpseclib PEAR Channel Documentation](http://phpseclib.sourceforge.net/pear.htm)
* [Download 1.0.8 as ZIP](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.8.zip/download)

## Support

Need Support?

* [Checkout Questions and Answers on Stack Overflow](http://stackoverflow.com/questions/tagged/phpseclib)
* [Create a Support Ticket on GitHub](https://github.com/phpseclib/phpseclib/issues/new)
* [Browse the Support Forum](http://www.frostjedi.com/phpbb/viewforum.php?f=46) (no longer in use)

## Contributing

1. Fork the Project

2. Ensure you have Composer installed (see [Composer Download Instructions](https://getcomposer.org/download/))

3. Install Development Dependencies

    ``` sh
    composer install
    ```

4. Create a Feature Branch

5. (Recommended) Run the Test Suite

    ``` sh
    vendor/bin/phpunit
    ```
6. (Recommended) Check whether your code conforms to our Coding Standards by running

    ``` sh
    vendor/bin/phing -f build/build.xml sniff
    ```

7. Send us a Pull Request
addition of gitattributes, gitignore and README files 2012-06-10 09:27:23 +00:00			`# phpseclib - PHP Secure Communications Library`

Revert "undo merging of master to 2.0 branch" This reverts commit 8fb4c3363d92a5004485354e8781d509ada83545. 2016-04-30 21:23:35 +00:00			`[![Build Status](https://travis-ci.org/phpseclib/phpseclib.svg?branch=master)](https://travis-ci.org/phpseclib/phpseclib)`
added build status and extra lines 2012-06-11 08:30:46 +00:00
addition of gitattributes, gitignore and README files 2012-06-10 09:27:23 +00:00			`MIT-licensed pure-PHP implementations of an arbitrary-precision integer`
			`arithmetic library, fully PKCS#1 (v2.1) compliant RSA, DES, 3DES, RC4, Rijndael,`
README: update version number / download link 2013-06-10 14:55:41 +00:00			`AES, Blowfish, Twofish, SSH-1, SSH-2, SFTP, and X.509`
addition of gitattributes, gitignore and README files 2012-06-10 09:27:23 +00:00
			`* [Browse Git](https://github.com/phpseclib/phpseclib)`
Merge branch '2.0' 2016-12-25 02:06:51 +00:00			`* [Code Coverage Report](https://coverage.phpseclib.org/master/latest/)`
README: add patreon link 2017-09-10 01:37:03 +00:00			`* Support phpseclib development by [![Becoming a patron](https://img.shields.io/badge/become-patron-brightgreen.svg)](https://www.patreon.com/phpseclib)`
Add section about Dependency Installation to README.md 2014-04-12 18:15:34 +00:00
Add "Documentation" section to README. Add link to Sami. 2014-08-01 15:57:06 +00:00			`## Documentation`

			`* [Documentation / Manual](http://phpseclib.sourceforge.net/)`
Merge branch '2.0' 2016-12-25 02:06:51 +00:00			`* [API Documentation](https://api.phpseclib.org/master/) (generated by Sami)`
Add "Documentation" section to README. Add link to Sami. 2014-08-01 15:57:06 +00:00
README: Add branches section. 2016-12-18 10:02:41 +00:00			`## Branches`

			`### master`

			`* Development Branch`
			`* Unstable API`
			`* Do not use in production`

			`### 2.0`

			`* Modernized version of 1.0`
			`* Minimum PHP version: 5.3.3`
			* PSR-4 autoloading with namespace rooted at `\phpseclib`
README: Fix typos. 2016-12-25 15:09:17 +00:00			* Install via Composer: `composer require phpseclib/phpseclib ~2.0`
README: Add branches section. 2016-12-18 10:02:41 +00:00
			`### 1.0`

			`* Long term support (LTS) release`
			`* PHP4 compatible`
			`* Composer compatible (PSR-0 autoloading)`
README: Reword 1.0 PEAR installation instructions. 2016-12-18 10:08:04 +00:00			* Install using Composer: `composer require phpseclib/phpseclib ~1.0`
README: Fix typos. 2016-12-25 15:09:17 +00:00			`* Install using PEAR: See [phpseclib PEAR Channel Documentation](http://phpseclib.sourceforge.net/pear.htm)`
README: update latest 1.0 version to 1.0.8 2017-10-23 05:03:25 +00:00			`* [Download 1.0.8 as ZIP](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.8.zip/download)`
Add "Documentation" section to README. Add link to Sami. 2014-08-01 15:57:06 +00:00
Add Support section to README. 2014-07-14 18:20:18 +00:00			`## Support`

			`Need Support?`

			`* [Checkout Questions and Answers on Stack Overflow](http://stackoverflow.com/questions/tagged/phpseclib)`
			`* [Create a Support Ticket on GitHub](https://github.com/phpseclib/phpseclib/issues/new)`
			`* [Browse the Support Forum](http://www.frostjedi.com/phpbb/viewforum.php?f=46) (no longer in use)`

README: Merge 'Installing Development Dependencies' into 'Contributing'. 2016-12-18 09:40:24 +00:00			`## Contributing`
Add section about Dependency Installation to README.md 2014-04-12 18:15:34 +00:00
README: Merge 'Installing Development Dependencies' into 'Contributing'. 2016-12-18 09:40:24 +00:00			`1. Fork the Project`
Add section about Dependency Installation to README.md 2014-04-12 18:15:34 +00:00
README: Merge 'Installing Development Dependencies' into 'Contributing'. 2016-12-18 09:40:24 +00:00			`2. Ensure you have Composer installed (see [Composer Download Instructions](https://getcomposer.org/download/))`
Add section about Dependency Installation to README.md 2014-04-12 18:15:34 +00:00
README: Merge 'Installing Development Dependencies' into 'Contributing'. 2016-12-18 09:40:24 +00:00			`3. Install Development Dependencies`
Add section about Dependency Installation to README.md 2014-04-12 18:15:34 +00:00
			``` sh
README: Remove pipe into php. 2016-12-18 09:38:28 +00:00			`composer install`
Add section about Dependency Installation to README.md 2014-04-12 18:15:34 +00:00			```
Add Contributing section to README.md 2014-04-12 18:26:27 +00:00
README: Merge 'Installing Development Dependencies' into 'Contributing'. 2016-12-18 09:40:24 +00:00			`4. Create a Feature Branch`
Add Contributing section to README.md 2014-04-12 18:26:27 +00:00
README: Merge 'Installing Development Dependencies' into 'Contributing'. 2016-12-18 09:40:24 +00:00			`5. (Recommended) Run the Test Suite`
Add Contributing section to README.md 2014-04-12 18:26:27 +00:00
			``` sh
			`vendor/bin/phpunit`
			```
README: Merge 'Installing Development Dependencies' into 'Contributing'. 2016-12-18 09:40:24 +00:00			`6. (Recommended) Check whether your code conforms to our Coding Standards by running`
Add Contributing section to README.md 2014-04-12 18:26:27 +00:00
			``` sh
			`vendor/bin/phing -f build/build.xml sniff`
			```

README: Merge 'Installing Development Dependencies' into 'Contributing'. 2016-12-18 09:40:24 +00:00			`7. Send us a Pull Request`