suzanne.soy/fork-openpgpjs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Tankred Hase 2014-01-10 19:24:12 +01:00
parent ac54a960fc
commit 786b0c2d3e
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -3,12 +3,12 @@ OpenPGP.js [![Build Status](https://secure.travis-ci.org/openpgpjs/openpgpjs.png
[OpenPGP.js](http://openpgpjs.org/) is a Javascript implementation of the OpenPGP protocol. This is defined in [RFC 4880](http://tools.ietf.org/html/rfc4880).
# How do I use it?
# Installation
## Node
npm install openpgpjs
## Browser
The library has AMD support but can also be accessed via window.openpgp
The library has AMD support but can also be accessed via 'window.openpgp'.
### Prebuilt minified release
You can download a prebuilt minified version of the library under [releases](https://github.com/openpgpjs/openpgpjs/releases).
@ -18,10 +18,13 @@ You can download a prebuilt minified version of the library under [releases](htt
Then take `dist/openpgp.min.js` to use in your project.
# I need some help
#Usage
It's best the check the documentation for detailed API information. There are also alot of useful examples under 'test/'.
## Documentation
A jsdoc build of our code comments is available at [doc/index.html](doc/index.html). Public calls should generally be made through the OpenPGP object [doc/openpgp.html](doc/openpgp.html).
# I need some help
## Mailing List
You can [sign up](http://list.openpgpjs.org/) for our mailing list and ask for help there. We've recently worked on getting our [archive up and running](http://www.mail-archive.com/list@openpgpjs.org/).