Skip to content

Commit cb2879a

Browse files
committedJun 27, 2020
Added TOC to README.
1 parent 25548bf commit cb2879a

File tree

4 files changed

+50
-0
lines changed

4 files changed

+50
-0
lines changed
 

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
* [#263](https://github.com/slack-ruby/slack-ruby-bot/pull/263): Removed Giphy support - [@dblock](https://github.com/dblock).
44
* [#260](https://github.com/slack-ruby/slack-ruby-bot/pull/260): Add brief migration guide - [@wasabigeek](https://github.com/wasabigeek).
5+
* [#264](https://github.com/slack-ruby/slack-ruby-bot/pull/264): Added TOC to README - [@dblock](https://github.com/dblock).
56
* Your contribution here.
67

78
### 0.15.0 (2020/5/8)

‎Dangerfile

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# frozen_string_literal: true
22

33
danger.import_dangerfile(gem: 'slack-ruby-danger')
4+
5+
toc.check!

‎Gemfile

+1
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ if ENV.key?('CONCURRENCY')
1414
end
1515

1616
group :test do
17+
gem 'danger-toc', '~> 0.2.0', require: false
1718
gem 'slack-ruby-danger', '~> 0.1.0', require: false
1819
end

‎README.md

+46
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,52 @@ If you are not familiar with Slack bots or Slack API concepts, you might want to
1111

1212
![](slack.png)
1313

14+
# Table of Contents
15+
16+
- [Useful to Me?](#useful-to-me)
17+
- [Stable Release](#stable-release)
18+
- [Usage](#usage)
19+
- [A Minimal Bot](#a-minimal-bot)
20+
- [Gemfile](#gemfile)
21+
- [pongbot.rb](#pongbotrb)
22+
- [A Production Bot](#a-production-bot)
23+
- [More Involved Examples](#more-involved-examples)
24+
- [Commands and Operators](#commands-and-operators)
25+
- [Threaded Messages](#threaded-messages)
26+
- [Bot Aliases](#bot-aliases)
27+
- [Generic Routing](#generic-routing)
28+
- [Matching text in message attachments](#matching-text-in-message-attachments)
29+
- [Providing description for your bot and commands](#providing-description-for-your-bot-and-commands)
30+
- [Customize your command help output](#customize-your-command-help-output)
31+
- [SlackRubyBot::Commands::Base](#slackrubybotcommandsbase)
32+
- [Authorization](#authorization)
33+
- [Built-In Commands](#built-in-commands)
34+
- [[bot name]](#bot-name)
35+
- [[bot name] hi](#bot-name-hi)
36+
- [[bot name] help](#bot-name-help)
37+
- [Hooks](#hooks)
38+
- [Implementing and registering a Hook Handler](#implementing-and-registering-a-hook-handler)
39+
- [Hooks registration on SlackRubyBot::Server initialization](#hooks-registration-on-slackrubybotserver-initialization)
40+
- [Hooks registration on a SlackRubyBot::Server instance](#hooks-registration-on-a-slackrubybotserver-instance)
41+
- [Hooks registration on SlackRubyBot::Server class](#hooks-registration-on-slackrubybotserver-class)
42+
- [Deprecated hook registration](#deprecated-hook-registration)
43+
- [Bot Message Protection](#bot-message-protection)
44+
- [Message Loop Protection](#message-loop-protection)
45+
- [Logging](#logging)
46+
- [Advanced Integration](#advanced-integration)
47+
- [Proxy Configuration](#proxy-configuration)
48+
- [Model-View-Controller Design](#model-view-controller-design)
49+
- [Controller](#controller)
50+
- [Model](#model)
51+
- [View](#view)
52+
- [Testing](#testing)
53+
- [RSpec Shared Behaviors](#rspec-shared-behaviors)
54+
- [Testing Lower Level Messages](#testing-lower-level-messages)
55+
- [Useful Libraries](#useful-libraries)
56+
- [Contributing](#contributing)
57+
- [Upgrading](#upgrading)
58+
- [Copyright and License](#copyright-and-license)
59+
1460
## Useful to Me?
1561

1662
* If you are just trying to send messages to Slack, use [slack-ruby-client](https://github.com/slack-ruby/slack-ruby-client), which this library is built on top of.

0 commit comments

Comments
 (0)
Please sign in to comment.