<commit_before>Kohana Module Template
======================

This is a base template intended to help you create your own Kohana 3 Module.

The intention is not to provide with a *fix structure* of how a module should be, but to provide an start point for your our custom modules.

How to use this module
----------------------

To use this **Kohana Module Template**, just:

1. Download and extract the code from [Github](https://github.com/sebicas/kohana-module-template).
2. Place the module into your Kohana instances modules folder.
3. Enable the module within the application bootstrap within the section entitled `modules`.

Go to `application/bootstrap.php`, look for `Kohana::modules()` and add:

<pre>
  'modulename' => MODPATH.'kohana-module-template', // Module Name & Path can be diferent if you like
</pre>

Example:

Replace 'modulename' and 'kohana-module-template' for your own name & path respectably.

<pre>
  Kohana::modules(array(
        // 'auth'       => MODPATH.'auth',       // Basic authentication
        // 'cache'      => MODPATH.'cache',      // Caching with multiple backends
        // 'codebench'  => MODPATH.'codebench',  // Benchmarking tool
        // 'database'   => MODPATH.'database',   // Database access
        // 'image'      => MODPATH.'image',      // Image manipulation
        // 'orm'        => MODPATH.'orm',        // Object Relationship Mapping
        // 'unittest'   => MODPATH.'unittest',   // Unit testing
        // 'userguide'  => MODPATH.'userguide',  // User guide and API documentation
        'modulename'  => MODPATH.'kohana-module-template',  // Add Module Name & Path
        ));
</pre>

See it working
--------------

To the module working go to:
[http://www.yoursite.com/modulename](http://www.yoursite.com/modulename)

How to Write a Module Resources
-------------------------------

Here is a list of articles I found about how to write your own Modules in Kohana 3

* [Writing a module for Kohana3](http://query7.com/writing-a-module-for-kohana3)
* [Kohana PHP 3.0 (KO3) Tutorial Part 8](http://www.dealtaker.com/blog/2010/04/30/kohana-php-3-0-ko3-tutorial-part-8/)

Contributing
------------

1. Fork it.
2. Create a branch (`git checkout -b my_markup`)
3. Commit your changes (`git commit -am "Added Snarkdown"`)
4. Push to the branch (`git push origin my_markup`)
5. Create an [Issue][1] with a link to your branch
6. Enjoy a refreshing orange juice and wait

Colaborators
------------

Thanks to the following colaborators:

* [sebicas](https://github.com/sebicas)

Future Planned support
----------------------

In the near future, additional support for the following methods will be included.

* **Jelly-style driver configuration**<commit_msg>Removing <pre> in README and adding 4 spaces to see Block<commit_after>Kohana Module Template
======================

This is a base template intended to help you create your own Kohana 3 Module.

The intention is not to provide with a *fix structure* of how a module should be, but to provide an start point for your our custom modules.

How to use this module
----------------------

To use this **Kohana Module Template**, just:

1. Download and extract the code from [Github](https://github.com/sebicas/kohana-module-template).
2. Place the module into your Kohana instances modules folder.
3. Enable the module within the application bootstrap within the section entitled `modules`.

Go to `application/bootstrap.php`, look for `Kohana::modules()` and add:

    'modulename' => MODPATH.'kohana-module-template', // Module Name & Path can be diferent if you like

Example:

Replace 'modulename' and 'kohana-module-template' for your own name & path respectably.

    Kohana::modules(array(
        // 'auth'       => MODPATH.'auth',       // Basic authentication
        // 'cache'      => MODPATH.'cache',      // Caching with multiple backends
        // 'codebench'  => MODPATH.'codebench',  // Benchmarking tool
        // 'database'   => MODPATH.'database',   // Database access
        // 'image'      => MODPATH.'image',      // Image manipulation
        // 'orm'        => MODPATH.'orm',        // Object Relationship Mapping
        // 'unittest'   => MODPATH.'unittest',   // Unit testing
        // 'userguide'  => MODPATH.'userguide',  // User guide and API documentation
        'modulename'  => MODPATH.'kohana-module-template',  // Add Module Name & Path
        ));

See it working
--------------

To the module working go to:
[http://www.yoursite.com/modulename](http://www.yoursite.com/modulename)

How to Write a Module Resources
-------------------------------

Here is a list of articles I found about how to write your own Modules in Kohana 3

* [Writing a module for Kohana3](http://query7.com/writing-a-module-for-kohana3)
* [Kohana PHP 3.0 (KO3) Tutorial Part 8](http://www.dealtaker.com/blog/2010/04/30/kohana-php-3-0-ko3-tutorial-part-8/)

Contributing
------------

1. Fork it.
2. Create a branch (`git checkout -b my_markup`)
3. Commit your changes (`git commit -am "Added Snarkdown"`)
4. Push to the branch (`git push origin my_markup`)
5. Create an [Issue][1] with a link to your branch
6. Enjoy a refreshing orange juice and wait

Colaborators
------------

Thanks to the following colaborators:

* [sebicas](https://github.com/sebicas)

Future Planned support
----------------------

In the near future, additional support for the following methods will be included.

* **Jelly-style driver configuration**
{'fraction_non_alphanumeric': 0.1566044639590194, 'fraction_numerical': 0.011525795828759604, 'mean_word_length': 2.7114731839782755, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 28, 'https://': 4, 'lorem ipsum': 0, 'www.': 6, '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': '2415339', 'n_tokens_mistral': 1620, 'n_tokens_neox': 1552, 'n_words': 579}