<commit_before># ghetto-shadow

The best project ever.

## Getting Started
### On the server
Install the module with: `npm install ghetto-shadow`

```javascript
var ghetto_shadow = require('ghetto-shadow');
ghetto_shadow.awesome(); // "awesome"
```

### In the browser
Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/stevoland/ghetto-shadow/master/dist/ghetto-shadow.min.js
[max]: https://raw.github.com/stevoland/ghetto-shadow/master/dist/ghetto-shadow.js

In your web page:

```html
<script src="dist/ghetto-shadow.min.js"></script>
<script>
awesome(); // "awesome"
</script>
```

In your code, you can attach ghetto-shadow's methods to any object.

```html
<script>
this.exports = Bocoup.utils;
</script>
<script src="dist/ghetto-shadow.min.js"></script>
<script>
Bocoup.utils.awesome(); // "awesome"
</script>
```

## Documentation
_(Coming soon)_

## Examples
_(Coming soon)_

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt).

_Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "lib" subdirectory!_

## Release History
_(Nothing yet)_

## License
Copyright (c) 2012 stevoland  
Licensed under the MIT license.<commit_msg>Added basic README<commit_after># ghetto-shadow

*WORK IN PROGRESS!*

The idea is to replicate the features of [Adobe Shadow][adobe] as far as possible using plain-old unpriveliged JavaScript on the client.

During your development you fire up a [Node.js][node] server and include a script tag on your site's pages pointing to a JS file on the server. From then on a 'click' event on one device is beamed to all your other devices that are viewing the same site.

No requirement to install an app on the device means you can test any device with a browser: smart TV, games console, kindle, washing machine... 

[adobe]: http://labs.adobe.com/technologies/shadow/
[node]: http://nodejs.org

## Getting Started

In your web pages:

```html
<script src="//localhost:8080/public/client.js?gskey=UNIQUE_KEY"></script>
```

## Documentation
_(Coming soon)_


## Examples
_(Coming soon)_


## Release History
_(Nothing yet)_


## License
Copyright (c) 2012 stevoland  
Licensed under the MIT license.
{'fraction_non_alphanumeric': 0.11983471074380166, 'fraction_numerical': 0.0049586776859504135, 'mean_word_length': 4.656542056074766, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '582259', 'n_tokens_mistral': 785, 'n_tokens_neox': 733, 'n_words': 279}