README.md (3272B)
1[](https://www.npmjs.com/package/guacamole-common-js) [](https://www.npmjs.com/package/guacamole-common-js) 2 3# What is guacamole-common-js? 4 5guacamole-common-js is the core JavaScript library used by the Guacamole web 6application. 7 8guacamole-common-js provides an efficient HTTP tunnel for transporting 9protocol data between JavaScript and the web application, as well as an 10implementation of a Guacamole protocol client and abstract synchronized 11drawing layers. 12 13## What is this fork for? 14 15This is a fork of [glyptodon/guacamole-client](https://github.com/glyptodon/guacamole-client) 16meant for distribution via npm. Prior to a version being submitted to npm a gulp buildscript 17combines all `guacamole-common-js` files and minifies them. 18 19None of the guacamole project files besides the combined javascript sources are included in 20the npm release, so you won't have to download any files you don't need. You can read which 21files/folders are omitted in the `.npmignore` file. 22 23You can install this library via npm: 24 25``` 26npm install --save guacamole-common-js 27``` 28 29```js 30const Guacamole = require('guacamole-common-js'); 31 32// ... or ES6 33import Guacamole from 'guacamole-common-js'; 34``` 35 36> Previously this fork was available as `padarom-guacamole-common-js`, which has been deprecated 37in favor of the new version of the fork which is much easier to maintain thanks to the gulp buildscript. 38 39#### Version numbers 40I intend to keep the npm version numbers identical to the guacamole version that I publish. This doesn't always work 100% in case something is missing or at fault, so I will need to release a patch. These patch versions still keep the same version number, but add a letter designating the patch (e.g. `1.0.0-b`). In case the guacamole upstream ever releases any patches with a similar version number, I can't guarantee that the patch letter of the original Guacamole sources and the release of this fork match up for that specific version. 41 42#### Fork origin 43Apparently the original repository `[glyptodon/guacamole-client](https://github.com/glyptodon/guacamole-client)` is no longer maintained and the actual guacamole client is now maintained at `[apache/guacamole-client](https://github.com/apache/guacamole-client)`. Unfortunately there is no way to rewrite the fork origin on GitHub, so this repository will show the wrong origin. In order to update from upstream, you may do the following: 44 45``` 46$ git remote add upstream git@github.com:apache/guacamole-client.git 47$ git pull upstream master --rebase 48``` 49 50## Documentation 51Distribution-specific packages are available from the files section of the main 52project page: 53 54 http://sourceforge.net/projects/guacamole/files/ 55 56Distribution-specific documentation is provided on the Guacamole wiki: 57 58 http://guac-dev.org/ 59 60# Reporting problems 61 62_I am not a maintainer or contributor to the original guacamole repository. I only created this fork and published it to npm._ 63 64Please report any bugs encountered by opening a new ticket at the Trac system hosted at: 65 66 http://guac-dev.org/trac/ 67 68Any bugs or questions to this fork specifically can be asked via issues on GitHub.