<commit_before>advlib
======

Web front-end for advlib via GitHub Pages.  Currently supports the following protocols:
* [Bluetooth Smart (BLE)](#bluetooth-smart-ble-advertising-packet-library)
* [reelyActive RFID](#reelyactive-rfid-library)

See the [advlib master branch](https://github.com/reelyactive/advlib) for more detailed documentation, or [advlib on npmjs](https://www.npmjs.com/package/advlib).


How we create this using browserify
-----------------------------------

#### Installing Browserify

[Browserify](http://browserify.org/) is a beautiful tool which bundles up and concatenates NodeJS modules for use in browser environments.  

To get started with browserify, install browserify globally with npm:

    npm install -g browserify

or

    sudo npm install -g browserify

#### Integrating Back-End Logic to Front-End Code

Feel free to require NodeJS modules you need to run your app, or any npm modules you need in order to write your AngularJS code for the browser in web/js/advapp.js. 

    var advlib = require('../../lib/index.js');
    var angular = require('angular');

If at this point you are confused that you are using NodeJS's module loading system for your browser's JavaScript code, do not worry as Browserify bundles it all up into a single neat and tidy JavaScript file which can be understood by the browser.

#### Using Browserify

Now to recursively bundle up all the required modules starting at web/js/advapp.js into a single file called advlib.js, use the following browserify command:

    browserify web/js/advapp.js -o web/js/advlib.js 

Finally, drop a single script tag into your index.html file and you are done!

``` html
<script src="js/advlib.js"></script>
```

Note: Browserify is called on the source in the [master branch](https://github.com/imranj131/advlib/tree/master)

Bluetooth Smart (BLE) Advertising Packet Library
------------------------------------------------

More info to come


reelyActive RFID Library
------------------------

More info to come


What's next?
------------

This is an active work in progress.  Expect regular changes and updates, as well as improved documentation!


License
-------

MIT License

Copyright (c) 2015 reelyActive

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
<commit_msg>brow docs<commit_after>advlib
======

Web front-end for advlib via GitHub Pages.  Currently supports the following protocols:
* [Bluetooth Smart (BLE)](#bluetooth-smart-ble-advertising-packet-library)
* [reelyActive RFID](#reelyactive-rfid-library)

See the [advlib master branch](https://github.com/reelyactive/advlib) for more detailed documentation, or [advlib on npmjs](https://www.npmjs.com/package/advlib).


How we create this using browserify
-----------------------------------

#### Installing Browserify

[Browserify](http://browserify.org/) is a beautiful tool which bundles up and concatenates NodeJS modules for use in browser environments.  

To get started with browserify, install browserify globally with npm:

    npm install -g browserify

or

    sudo npm install -g browserify

#### Integrating Back-End Logic to Front-End Code

Feel free to require NodeJS modules you need to run your app, or any npm modules you need in order to write your AngularJS code for the browser in web/js/advapp.js. 

    var advlib = require('../../lib/index.js');
    var angular = require('angular');

If at this point you are confused that you are using NodeJS's module loading system for your browser's JavaScript code, do not worry as Browserify bundles it all up into a single neat and tidy JavaScript file which can be understood by the browser.

#### Using Browserify

Now to recursively bundle up all the required modules starting at web/js/advapp.js into a single file called advlib.js, use the following browserify command:

    browserify web/js/advapp.js -o web/js/advlib.js 

Finally, drop a single script tag into your index.html file and you are done!

``` html
<script src="js/advlib.js"></script>
```

Note: Browserify is called on the source code in the [master branch.](https://github.com/imranj131/advlib/tree/master)

Bluetooth Smart (BLE) Advertising Packet Library
------------------------------------------------

More info to come


reelyActive RFID Library
------------------------

More info to come


What's next?
------------

This is an active work in progress.  Expect regular changes and updates, as well as improved documentation!


License
-------

MIT License

Copyright (c) 2015 reelyActive

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

{'fraction_non_alphanumeric': 0.11739293764087153, 'fraction_numerical': 0.002629601803155522, 'mean_word_length': 3.459798994974874, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '390773', 'n_tokens_mistral': 1438, 'n_tokens_neox': 1320, 'n_words': 658}