Merge branch 'master' into refactor

This commit is contained in:
Robert Nelson 2014-01-06 06:44:52 -08:00
commit 0cd56ef418
5 changed files with 5 additions and 45 deletions

3
.gitmodules vendored
View File

@ -1,3 +0,0 @@
[submodule "Dependencies/sjcl"]
path = Dependencies/sjcl
url = git://github.com/bitwiseshiftleft/sjcl.git

1
Dependencies/sjcl vendored

@ -1 +0,0 @@
Subproject commit 1a6c455cad62db24d80b3b8ea6fe2def6a440fb9

View File

@ -1,35 +0,0 @@
default: help
help:
@echo "update - get latest sources"
@echo "bundle - makes JavaScript download and run faster"
@echo "lint - checks JavaScript files for style issues"
@echo "test - runs JavaScript unit tests"
@echo "example - creates a simple example"
@echo "documentation - generates documentation. Requires jsdoc (3.2) in PATH"
update: update-me update-deps
update-me:
@git pull
update-deps:
@git submodule foreach git pull
bundle:
@grunt
lint:
@grunt jshint
test:
@npm test
example:
@mkdir -p build
@rm -f build/openpgpjs-0.x.zip
@zip -j build/openpgpjs-0.x.zip resources/example.* resources/openpgp.min.js resources/jquery.min.js
@echo "Have a look at build/openpgpjs-0.x.zip"
documentation:
@grunt jsdoc

View File

@ -4,13 +4,13 @@ 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?
To build the library, checkout the HEAD of the master branch or download a stable (old) tagged version from [releases](https://github.com/openpgpjs/openpgpjs/releases).
You can download a prebuilt minified version of the library under [releases](https://github.com/openpgpjs/openpgpjs/releases).
Then build the library:
You can also build a current version yourself:
npm install && grunt
Then take the use the minified file from `resources/openpgp.min.js` and use it in your project.
Then take the resulting file from `resources/openpgp.min.js` to use in your project.
# I need some help
## Mailing List

View File

@ -6,9 +6,8 @@
},
"main": "./src/index.js",
"scripts": {
"pretest": "grunt browserify",
"test": "grunt test",
"start": "grunt dev"
"pretest": "grunt",
"test": "grunt test"
},
"devDependencies": {
"browserify": "~2.35",