From edf9b412949c7d2f093d1f4c0c8c3cde60f7584f Mon Sep 17 00:00:00 2001 From: Corey Osman Date: Fri, 10 Feb 2017 12:39:28 -0800 Subject: [PATCH] Adds a table of contents to the readme and contributing files * uses the doctoc utility to easily generate the table of contents --- CHANGELOG.md | 1 + CONTRIBUTING.md | 13 +++++++++++++ README.md | 30 ++++++++++++++++++++++++++++++ 3 files changed, 44 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c40cc57e..2d52f884c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -49,6 +49,7 @@ As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch. (https://github.com/mbleigh/acts-as-taggable-on/commit/9cc580e7f88164634eb10c8826e5b30ea0e00544) * Documentation + * [@logicminds Adds table of contents using doctoc utility](https://github.com/mbleigh/acts-as-taggable-on/pull/803) * [@jamesprior Changing ActsAsTaggable to ActsAsTaggableOn ](https://github.com/mbleigh/acts-as-taggable-on/pull/637) * [@markgandolfo Update README.md](https://github.com/mbleigh/acts-as-taggable-on/pull/645)) * [@snowblink Update release date for 3.5.0](https://github.com/mbleigh/acts-as-taggable-on/pull/647) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2451be5eb..30b9b3981 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,16 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [How to contribute:](#how-to-contribute) + - [Bug reports / Issues](#bug-reports--issues) + - [Code](#code) + - [Commit Messages](#commit-messages) + - [About Pull Requests (PR's)](#about-pull-requests-prs) + - [Documentation](#documentation) + + + # How to contribute: ## Bug reports / Issues diff --git a/README.md b/README.md index bb762e96b..674463034 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [ActsAsTaggableOn](#actsastaggableon) + - [Installation](#installation) + - [Post Installation](#post-installation) + - [For MySql users](#for-mysql-users) + - [Usage](#usage) + - [Finding most or least used tags](#finding-most-or-least-used-tags) + - [Finding Tagged Objects](#finding-tagged-objects) + - [Relationships](#relationships) + - [Dynamic Tag Contexts](#dynamic-tag-contexts) + - [Tag Parsers](#tag-parsers) + - [Tag Ownership](#tag-ownership) + - [Working with Owned Tags](#working-with-owned-tags) + - [Adding owned tags](#adding-owned-tags) + - [Removing owned tags](#removing-owned-tags) + - [Dirty objects](#dirty-objects) + - [Tag cloud calculations](#tag-cloud-calculations) + - [Configuration](#configuration) + - [Upgrading](#upgrading) + - [Contributors](#contributors) + - [Compatibility](#compatibility) + - [TODO](#todo) + - [Testing](#testing) + - [License](#license) + + + # ActsAsTaggableOn [![Join the chat at https://gitter.im/mbleigh/acts-as-taggable-on](https://badges.gitter.im/mbleigh/acts-as-taggable-on.svg)](https://gitter.im/mbleigh/acts-as-taggable-on?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)