This repository has been archived by the owner on Dec 11, 2020. It is now read-only.
Adds a table of contents to the readme file. #613
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| - [Installation](#installation) | ||
| - [Basic Usage](#basic-usage) | ||
| - [Formatters](#formatters) | ||
| - [`FakerProviderBase`](#fakerproviderbase) |
There was a problem hiding this comment.
No need to repeat FakerProvider, or to make them code formatted. I'd simply label subsections Base, Lorem, Person, etc.
|
Great idea! |
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.
|
All right, updated the pull request per your notes. I agree with the notes, btw, wasn't sure if you'd want it code formatted, figured it'd be best to just pass it by you first. |
fzaninotto
added a commit
that referenced
this pull request
Jun 23, 2015
Adds a table of contents to the readme file.
|
Awesome, thanks a lot! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Let me know if there are any changes you want me to make. Great library, btw, I'm really enjoying using it.