<commit_before>Getting Started
===============

Requirements
------------
No external component or library is required.
You simply need a standard PHP installation to work with Jaxl.

Library has been developed and tested extensively on 
linux operating systems. But there is no reason why it should
not work on other OS. File an `issue <https://github.com/jaxl/JAXL/issues/new>`_ if you face any glitches.

Download & Install
------------------
Download a stable tagged v3.x release from `https://github.com/jaxl/JAXL/tags <https://github.com/jaxl/JAXL/tags>`_

You can also checkout git branch and switch to a tag of your choice:

    >>> git clone https://github.com/jaxl/JAXL.git
    >>> cd JAXL/
    >>> git tag -l
    >>> git checkout some-tag-name

To install Jaxl library globally, simply append path of the downloaded ``JAXL`` folder
to ``include_path`` directive inside your ``php.ini``. This will allow us to use Jaxl 
library simply by doing:

``require 'jaxl.php';`` 

Alternately, if you don't want to edit ``php.ini`` or in case you don't have 
access to the ini file, simply use:

``require '/full/path/to/JAXL/jaxl.php';``

to start using Jaxl library.

Library Structure
-----------------
Jaxl library comprises of following packages:

    * ``jaxl-core``
        
            contains generic networking and eventing components
            
    * ``jaxl-xmpp``
        
            contains xmpp rfc implementation
            
    * ``jaxl-xmpp-xep``
        
            contains various xmpp xep implementation
            
    * ``jaxl-http``
        <commit_msg>Update install section<commit_after>Getting Started
===============

Requirements
------------
No external component or library is required.
You simply need a standard PHP installation to work with Jaxl.

Library has been developed and tested extensively on 
linux operating systems. But there is no reason why it should
not work on other OS. File an `issue <https://github.com/jaxl/JAXL/issues/new>`_ if you face any glitches.

Install
-------

Use `Composer <https://getcomposer.org>`_ to install:

composer require "jaxl/jaxl=^3.0.2"

Library Structure
-----------------
Jaxl library comprises of following packages:

    * ``jaxl-core``
        
            contains generic networking and eventing components
            
    * ``jaxl-xmpp``
        
            contains xmpp rfc implementation
            
    * ``jaxl-xmpp-xep``
        
            contains various xmpp xep implementation
            
    * ``jaxl-http``
        
{'fraction_non_alphanumeric': 0.12386228729719034, 'fraction_numerical': 0.0015829046299960427, 'mean_word_length': 2.4162162162162164, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 19, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 3, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '337359', 'n_tokens_mistral': 726, 'n_tokens_neox': 697, 'n_words': 269}