From 18fca0b17839bf84ee7b71b83066f4d76d46134c Mon Sep 17 00:00:00 2001 From: Camilo Payan Date: Thu, 18 Jun 2015 23:19:41 -0400 Subject: [PATCH] Adds a table of contents to the readme file. I found it really hard to get around the readme to answer my questions quickly. I wasn't familiar enough with it to search for what I needed. To that end, I created a readme file to go with it. --- readme.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/readme.md b/readme.md index 8ae00f545f..657cd890ff 100644 --- a/readme.md +++ b/readme.md @@ -8,6 +8,40 @@ Faker requires PHP >= 5.3.3. [![Monthly Downloads](https://poser.pugx.org/fzaninotto/faker/d/monthly.png)](https://packagist.org/packages/fzaninotto/faker) [![Build Status](https://secure.travis-ci.org/fzaninotto/Faker.png)](http://travis-ci.org/fzaninotto/Faker) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/eceb78a9-38d4-4ad5-8b6b-b52f323e3549/mini.png)](https://insight.sensiolabs.com/projects/eceb78a9-38d4-4ad5-8b6b-b52f323e3549) +# Table of Contents + +- [Installation](#installation) +- [Basic Usage](#basic-usage) +- [Formatters](#formatters) + - [Base](#fakerproviderbase) + - [Lorem Ipsum Text](#fakerproviderlorem) + - [Person](#fakerprovideren_usperson) + - [Address](#fakerprovideren_usaddress) + - [PhoneNumber](#fakerprovideren_usphonenumber) + - [Company](#fakerprovideren_uscompany) + - [Text](#fakerprovideren_ustext) + - [DateTime](#fakerproviderdatetime) + - [Internet](#fakerproviderinternet) + - [UserAgent](#fakerprovideruseragent) + - [Payment](#fakerproviderpayment) + - [Color](#fakerprovidercolor) + - [File](#fakerproviderfile) + - [Image](#fakerproviderimage) + - [Uuid](#fakerprovideruuid) + - [Barcode](#fakerproviderbarcode) + - [Miscellaneous](#fakerprovidermiscellaneous) + - [Biased](#fakerproviderbiased) +- [Unique and Optional modifiers](#unique-and-optional-modifiers) +- [Localization](#localization) +- [Populating Entities Using an ORM or an ODM](#populating-entities-using-an-orm-or-an-odm) +- [Seeding the Generator](#seeding-the-generator) +- [Faker Internals: Understanding Providers](#faker-internals-understanding-providers) +- [Real Life Usage](#real-life-usage) +- [Language specific formatters](#language-specific-formatters) +- [Third-Party Libraries Extending/Based On Faker](#third-party-libraries-extendingbased-on-faker) +- [License](#license) + + ## Installation ```sh