docs(readme): add table of contents #86
Merged
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.
This PR aims to clean up the README a little bit and add a table of contents. I see this as a first step to resolving #61.
I generated the table of contents by running
npx doctoc README.md --notitle --maxlevel=3
. I wanted to set up lint-staged in this PR, but I had trouble installing it using Node 4 and npm 2 in my local development environment. (I'll open an issue to discuss using Node 8 and npm 5 as the preferred development environment, but continue running tests on Node 4 to continue supporting that version of Node with this ESLint plugin.)The primary change is that all rules are documented below the Rules section with the following convention:
This allows for consistent documentation URLs, which now look like
https://github.com/xjamundx/eslint-plugin-promise#rule-name
.Once this is merged, I will open a follow up PR to add the
meta.docs.url
field to all rules, which should close #61. (ESLint did a similar thing in their codebase in eslint/eslint#9788)