Mercurial > hg > rc1

comparison vendor/pear/crypt_gpg/README.md @ 0:1e000243b222

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
vanilla 1.3.3 distro, I hope
author Charlie Root
date Thu, 04 Jan 2018 15:50:29 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:1e000243b222
1 # Crypt_GPG #
2 Crypt_GPG is a PHP package to interact with the [GNU Privacy Guard
3 (GnuPG)](http://www.gnupg.org/). GnuPG is a free and open-source
4 implementation of the [OpenPGP](http://www.ietf.org/rfc/rfc4880.txt)
5 protocol, providing key management, data encryption and data signing.
6 Crypt_GPG provides an object-oriented API for performing OpenPGP
7 actions using GnuPG.
8
9 [Crypt_GPG](http://pear.php.net/package/Crypt_GPG) has been
10 migrated from [PEAR SVN](https://svn.php.net/repository/pear/packages/Crypt_GPG).
11
12 ## Documentation ##
13
14 ### Quick Example
15 ```php
16 <?php
17
18 require_once 'Crypt/GPG.php';
19
20 $gpg = new Crypt_GPG();
21 $gpg->addEncryptKey('test@example.com');
22 $data = $gpg->encrypt('my secret data');
23
24 ?>
25 ```
26
27 ### Further Documentation ###
28 * [High-Level Documentation](http://pear.php.net/manual/en/package.encryption.crypt-gpg.intro.php)
29 * [Detailed API Documentation](http://pear.php.net/package/Crypt_GPG/docs/latest/)
30
31 ## Bugs and Issues ##
32 Please report all new issues via the [PEAR bug tracker](http://pear.php.net/bugs/search.php?cmd=display&package_name[]=Crypt_GPG).
33
34 Please submit pull requests for your bug reports!
35
36 ## Testing ##
37 To test, run either
38 `$ phpunit tests/`
39 or
40 `$ pear run-tests -r`
41
42 ## Building ##
43 To build, simply
44 `$ pear package`
45
46 ## Installing ##
47 To install from scratch
48 `$ pear install package.xml`
49
50 To upgrade
51 `$ pear upgrade -f package.xml`