aboutsummaryrefslogtreecommitdiff
path: root/includes/vendor/ozh/bookmarkletgen/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'includes/vendor/ozh/bookmarkletgen/README.md')
-rw-r--r--includes/vendor/ozh/bookmarkletgen/README.md74
1 files changed, 74 insertions, 0 deletions
diff --git a/includes/vendor/ozh/bookmarkletgen/README.md b/includes/vendor/ozh/bookmarkletgen/README.md
new file mode 100644
index 0000000..e091b3a
--- /dev/null
+++ b/includes/vendor/ozh/bookmarkletgen/README.md
@@ -0,0 +1,74 @@
+# Bookmarklet Gen [![](https://travis-ci.org/ozh/bookmarkletgen.svg?branch=master)](https://travis-ci.org/ozh/bookmarkletgen)
+
+Convert readable Javascript code into bookmarklet links
+
+## Features
+
+- removes comments
+
+- compresses code by removing extraneous spaces, but not within literal strings.
+ Example:
+ ```javascript
+ function someName( param ) {
+ alert( "this is a string" )
+ }
+ ```
+ will return:
+ ```javascript
+ function%20someName(param){alert("this%20is%20a%20string")}
+ ```
+- encodes what needs to be encoded
+
+- wraps code into a self invoking function ready for bookmarking
+
+This is basically a slightly enhanced PHP port of the excellent Bookmarklet Crunchinator:
+http://ted.mielczarek.org/code/mozilla/bookmarklet.html
+
+## Installation
+
+If you are using Composer, add this requirement to your `composer.json` file and run `composer install`:
+
+ {
+ "require": {
+ "ozh/phpass": "1.2.0"
+ }
+ }
+
+Or simply in the command line : `composer install ozh/bookmarkletgen`
+
+If you're not using composer, download the class file and include it manually.
+
+## Example
+
+```php
+<?php
+$javascript = <<<CODE
+var link="http://google.com/"; // destination
+window.location = link;
+CODE;
+
+require 'vendor/autoload.php'; // if you install using Composer
+require 'path/to/Bookmarkletgen.php'; // otherwise
+
+$book = new \Ozh\Bookmarkletgen\Bookmarkletgen;
+$link = $book->crunch( $javascript );
+
+printf( '<a href="%s">bookmarklet</a>', $link );
+```
+
+will print:
+
+```html
+<a href="javascript:(function()%7Bvar%20link%3D%22http%3A%2F%2Fgoogle.com%2F%22%3Bwindow.location%3Dlink%3B%7D)()%3B">bookmarklet</a>
+```
+
+## Tests
+
+This library comes with unit tests to make sure the resulting crunched Javascript is valid code.
+
+This library requires PHP 5.3. Tests are failing on HHVM because of an external binary issue (`phantomjs`) but things should work anyway on HHVM too.
+
+## License
+
+Do whatever the hell you want to do with it
+