diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 7ec72a16..00000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "Dependencies/sjcl"] - path = Dependencies/sjcl - url = git://github.com/bitwiseshiftleft/sjcl.git diff --git a/Dependencies/sjcl b/Dependencies/sjcl deleted file mode 160000 index 1a6c455c..00000000 --- a/Dependencies/sjcl +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 1a6c455cad62db24d80b3b8ea6fe2def6a440fb9 diff --git a/Makefile b/Makefile deleted file mode 100644 index e1646bc2..00000000 --- a/Makefile +++ /dev/null @@ -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 diff --git a/README.md b/README.md index 48bed4fe..28bb3e0c 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index e4b5c2d5..cf23e6dc 100644 --- a/package.json +++ b/package.json @@ -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",