<commit_before>.. PHP Password Library documentation master file, created by
   sphinx-quickstart on Fri Sep 21 15:59:59 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PHP Password Library's documentation!
================================================

Contents:

.. toctree::
   :maxdepth: 2



Indices and tables
==================

* :ref:`genindex`<commit_msg>Update index to include quick example<commit_after>.. PHP Password Library documentation master file, created by
   sphinx-quickstart on Fri Sep 21 15:59:59 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

========================================================================
PHP Password Library |release| Documentation
========================================================================

Introduction
============

The PHP Password Library (PHPassLib) is a library for PHP 5.3+ designed
to make working with passwords as easy as possible. Tasks such as
creating password hashes, verifying passwords, and migrating stored
hashes are made simple::

    <?php
    require 'PHPassLib.php';
    use PHPassLib\Hash\BCrypt;
    
    $hash = BCrypt::hash($password);
    if (BCrypt::verify($password, $hash)) {
        // Authentication passed!
    }

Indices and tables
==================

* :ref:`genindex`
{'fraction_non_alphanumeric': 0.22815533980582525, 'fraction_numerical': 0.01872399445214979, 'mean_word_length': 4.795180722891566, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, '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': '5765997', 'n_tokens_mistral': 394, 'n_tokens_neox': 345, 'n_words': 146}