<commit_before># baboon client [![Build Status](https://img.shields.io/travis/litixsoft/baboon-client/v0.4.svg)](https://travis-ci.org/litixsoft/baboon-client) [![david-dm](https://david-dm.org/litixsoft/baboon-client.png)](https://david-dm.org/litixsoft/baboon-client/) [![david-dm](https://david-dm.org/litixsoft/baboon-client/dev-status.png)](https://david-dm.org/litixsoft/baboon-client#info=devDependencies&view=table)

> Baboon-Client is a client library for [baboon webtoolkit](https://github.com/litixsoft/baboon). It also has different directives to simplify tasks in client web development.

* Web site: http://www.litixsoft.de/baboon
* Tutorial: http://www.litixsoft.de/baboon/tutorial
* API Docs: http://www.litixsoft.de/baboon/api
* Developer Guide: http://www.litixsoft.de/baboon/guide

# Install
The installation of a Baboon project is very simple. However, some preparatory work is needed.

## Global dependencies:

Linux / Mac:
    $ sudo npm install -g bower

Windows:
    $ npm install -g bower

## Create and start your baboon project
Usual baboon-client standard installation over bower registry:

    $ bower install baboon-client

[Learn more about usage of Bower](https://github.com/bower/bower#usage)

# Contributing
Instead of us handing out a formal style guide, simply stick to the existing programming style. Please create descriptive commit messages.
We use a git hook to validate the commit messages against these [rules](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w).
Easily expand Baboon-Client with your own extensions or changes in the functionality of Baboon-Client itself. Use this workflow:

1. Write your functionality
2. Write unit tests for your functionality
3. Create an example of your functionality in the guide
4. Document your functionality in the documentation section of the guide
5. All tests should be successful
6. Check your test coverage (90 - 100%)
7. Make a pull request

We will check the tests, the example and test coverage. In case your changes are useful and well tested, we will merge your requests.

# Building and Testing Baboon-Client
This section describes how to set up your development environment to build and test Baboon-Client with the guide.

## Global dependencies:

Linux / Mac:

    $ sudo npm install -g grunt-cli karma bower

Windows:

    $ npm install -g grunt-cli karma bower


## Clone Baboon-Client and guide
The guide is also the reference implementation for Baboon-Client.
Clone Baboon-Client repository and install the dependent modules with npm and bower.

Clone the baboon-client repository and install the dev dependencies and test suite deps.
Test baboon-client with grunt.

    $ git clone https://github.com/litixsoft/baboon-client.git
    $ cd baboon-client
    $ npm install
    $ bower install

Alternate you can use the update script:

    $ git clone https://github.com/litixsoft/baboon-client.git
    $ cd baboon-client
    $ ./update.sh // in windows use update.bat

## Running tests
You can run all unit tests for Baboon-Client with:

    $ grunt test // directory baboon-client

## Running coverage
You can run a coverage task for Baboon-Client with:

    $ grunt cover // directory baboon-client

## Running tests for ci systems
You can run unit tests, jshint and code coverage for ci systems with:
    $ grunt ci

## Generate Documentation
You can generate the documentation for baboon-client with:

    $ grunt doc

## Running guide and documentation
You can start the node application and run the guide under http://localhost:3000.

    $ node server.js

# Author
[Litixsoft GmbH](http://www.<EMAIL>)

# License
Copyright (C) 2013-2014 Litixsoft GmbH <<EMAIL>>
Licensed under the MIT license.

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<commit_msg>chore: update readme<commit_after># baboon client [![Build Status](https://img.shields.io/travis/litixsoft/baboon-client/v0.4.svg)](https://travis-ci.org/litixsoft/baboon-client) [![david-dm](https://david-dm.org/litixsoft/baboon-client.png)](https://david-dm.org/litixsoft/baboon-client/) [![david-dm](https://david-dm.org/litixsoft/baboon-client/dev-status.png)](https://david-dm.org/litixsoft/baboon-client#info=devDependencies&view=table)

> Baboon-Client is a client library for [baboon webtoolkit](https://github.com/litixsoft/baboon). It also has different directives to simplify tasks in client web development.

* Web site: http://www.litixsoft.de/baboon
* Tutorial: http://www.litixsoft.de/baboon/tutorial
* API Docs: http://www.litixsoft.de/baboon/api
* Developer Guide: http://www.litixsoft.de/baboon/guide

# Install
The installation of a Baboon project is very simple. However, some preparatory work is needed.

## Global dependencies:

Linux / Mac:
    $ sudo npm install -g bower

Windows:
    $ npm install -g bower

## Create and start your baboon project
Usual baboon-client standard installation over bower registry:

    $ bower install baboon-client

[Learn more about usage of Bower](https://github.com/bower/bower#usage)

# Contributing
Instead of us handing out a formal style guide, simply stick to the existing programming style. Please create descriptive commit messages.
We use a git hook to validate the commit messages against these [rules](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w).
Easily expand Baboon-Client with your own extensions or changes in the functionality of Baboon-Client itself. Use this workflow:

1. Write your functionality
2. Write unit tests for your functionality
3. Create an example of your functionality in the guide
4. Document your functionality in the documentation section of the guide
5. All tests should be successful
6. Check your test coverage (90 - 100%)
7. Make a pull request

We will check the tests, the example and test coverage. In case your changes are useful and well tested, we will merge your requests.

# Building and Testing Baboon-Client
This section describes how to set up your development environment to build and test Baboon-Client with the guide.

## Global dependencies:

Linux / Mac:

    $ sudo npm install -g grunt-cli karma bower

Windows:

    $ npm install -g grunt-cli karma bower


## Clone Baboon-Client and guide
The guide is also the reference implementation for Baboon-Client.
Clone Baboon-Client repository and install the dependent modules with npm and bower.

Clone the baboon-client repository and install the dev dependencies and test suite deps.
Test baboon-client with grunt.

    $ git clone https://github.com/litixsoft/baboon-client.git
    $ cd baboon-client
    $ npm install
    $ bower install

Alternate you can use the update script:

    $ git clone https://github.com/litixsoft/baboon-client.git
    $ cd baboon-client
    $ ./update.sh // in windows use update.bat

## Running tests
You can run all unit tests for Baboon-Client with:

    $ grunt test // directory baboon-client

## Running coverage
You can run a coverage task for Baboon-Client with:

    $ grunt cover // directory baboon-client

## Running tests for ci systems
You can run unit tests, jshint and code coverage for ci systems with:

    $ grunt ci

## Generate Documentation
You can generate the documentation for baboon-client with:

    $ grunt doc

## Running guide and documentation
You can start the node application and run the guide under http://localhost:3000.

    $ node server.js

# Author
[Litixsoft GmbH](http://www.litixsoft.de)

# License
Copyright (C) 2013-2014 Litixsoft GmbH <<EMAIL>>
Licensed under the MIT license.

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
{'fraction_non_alphanumeric': 0.08378007729709512, 'fraction_numerical': 0.008976436853260192, 'mean_word_length': 4.145606157793457, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 10, 'https://': 22, 'lorem ipsum': 0, 'www.': 10, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '32929', 'n_tokens_mistral': 2424, 'n_tokens_neox': 2276, 'n_words': 909}