Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds a table of contents to the readme and contributing files #803

Merged
merged 1 commit into from
May 3, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**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)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# How to contribute:

## Bug reports / Issues
Expand Down
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**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)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# 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)
Expand Down