Skip to content

Commit b526f84

Browse files
committed
Modernize titles in READMEs
1 parent 50006a0 commit b526f84

File tree

8 files changed

+29
-31
lines changed

8 files changed

+29
-31
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,22 @@ Minimalistic yet polyglot framework to build chat bots on top of a Roda backend
1717

1818
Thank you for supporting free and open-source software by sponsoring on [GitHub](https://github.com/sponsors/svoop) or on [Donorbox](https://donorbox.com/bitcetera). Any gesture is appreciated, from a single Euro for a ☕️ cup of coffee to 🍹 early retirement.
1919

20-
## Table of Contents
20+
## Table of contents
2121

2222
[Install](#install) <br>
2323
[Anatomy](#anatomy) <br>
24-
&emsp;&emsp;&emsp;[App Service](#app-service) <br>
25-
&emsp;&emsp;&emsp;[Relay Services](#relay-services) <br>
26-
&emsp;&emsp;&emsp;[Schedule Service](#schedule-service) <br>
24+
&emsp;&emsp;&emsp;[App service](#app-service) <br>
25+
&emsp;&emsp;&emsp;[Relay services](#relay-services) <br>
26+
&emsp;&emsp;&emsp;[Schedule service](#schedule-service) <br>
2727
[CLI](#CLI) <br>
2828
[Request](#request)<br>
2929
[Say](#say)<br>
30-
[Routes and Commands](#routes-and-commands) <br>
30+
[Routes and commands](#routes-and-commands) <br>
3131
[Database](#database) <br>
3232
[Environments](#environments) <br>
3333
[Credentials](#credentials) <br>
3434
[Plugins](#plugins) <br>
35-
[Environment Variables](#environment-variables) <br>
35+
[Environment variables](#environment-variables) <br>
3636
[Development](#development) <br>
3737

3838
## Install
@@ -45,7 +45,7 @@ This gem is [cryptographically signed](https://guides.rubygems.org/security/#usi
4545
gem cert --add <(curl -Ls https://raw.github.com/svoop/rodbot/main/certs/svoop.pem)
4646
```
4747

48-
### Generate New Bot
48+
### Generate new bot
4949

5050
Similar to other frameworks, generate the files for your new bot as follows:
5151

@@ -106,7 +106,7 @@ RODBOT EXTERNAL
106106
╰╴ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ╶╯
107107
```
108108

109-
### App Service
109+
### App service
110110

111111
The **app service** is a [Roda app](https://roda.jeremyevans.net) where the real action happens. It acts on and responds to HTTP requests from:
112112

@@ -177,11 +177,11 @@ Tag | Replaced with
177177
`[[SENDER]]` | Mention the sender of the command.
178178
`[[EVERYBODY]]` | Mention everybody.
179179

180-
#### Other Routes
180+
#### Other routes
181181

182182
All higher level requests such as `GET /foo/bar` are not accessible by relays. Use them to implement other aspects of your bot such as webhooks or schedule tasks.
183183

184-
### Relay Services
184+
### Relay services
185185

186186
The **relay service** act as glue between the **app service** and external communication networks such as Matrix.
187187

@@ -199,15 +199,15 @@ rodbot simulator
199199

200200
Enter the command `!pay EUR 123` and you see the request `GET /pay?argument=EUR+123` hitting the **app service**.
201201

202-
#### TCP Socket
202+
#### TCP socket
203203

204204
The TCP socket is primarily used by other Rodbot services to forward messages to the corresponding external communication network. However, you can use these sockets for non-Rodbot processes as well e.g. to issue notifications when events happen on the host running Rodbot.
205205

206206
Simply connect to a socket and submit the message as plain text or Markdown in UTF-8. Multiple lines are allowed, to finish and post the message, append the EOT character (`\x04` alias Ctrl-D).
207207

208208
Such simple messages are always posted to the primary room (aka: channel, group etc) of the communication network. For more complex scenarios, please take a look at [message objects](https://www.rubydoc.info/gems/rodbot/Rodbot/Message) which may contain meta information as well.
209209

210-
### Schedule Service
210+
### Schedule service
211211

212212
The **schedule service** is a [Clockwork process](https://github.com/Rykian/clockwork) which triggers Ruby code asynchronously as configured in `config/schedule.rb`.
213213

@@ -227,7 +227,7 @@ The `rodbot` CLI is the main tool to manage your bot. For a full list of functio
227227
rodbot --help
228228
```
229229

230-
### Starting and Stopping Services
230+
### Starting and stopping services
231231

232232
While working on the app service, you certainly want to try routes:
233233

@@ -364,7 +364,7 @@ You can further narrow where to post the message if you specify the relay plugin
364364
say("Hello, Slack!", on: :slack)
365365
```
366366

367-
## Routes and Commands
367+
## Routes and commands
368368

369369
Adding new tricks to your bot boils down to adding routes to the app service which is powered by Roda, a simple yet very powerful framework for web applications: Easy to learn (like Sinatra) but really fast and efficient. Take a minute and [get familiar with the basics of Roda](http://roda.jeremyevans.net/).
370370

@@ -430,7 +430,7 @@ The Hash backend is not thread-safe and therefore shouldn't be used in productio
430430
db 'hash'
431431
```
432432

433-
### Write and Read Data
433+
### Write and read data
434434

435435
With this in place, you can access the database with `Rodbot.db`:
436436

@@ -480,7 +480,7 @@ In order not to commit secrets to repositories or environment variables, Rodbot
480480

481481
Rodbot aims to keep its core small and add features via plugins, either built-in or provided by gems.
482482

483-
### Built-In Plugins
483+
### Built-in plugins
484484

485485
Name | Dependencies | Description
486486
-----|--------------|------------
@@ -499,7 +499,7 @@ bundle config set --local with otp
499499
bundle install
500500
```
501501

502-
### How Plugins Work
502+
### How plugins work
503503

504504
Given the following `config/rodbot.rb`:
505505

@@ -519,7 +519,7 @@ Whenever a service boots, the corresponding file is required.
519519

520520
In order to keep these plugin files slim, you should extract functionality into service classes. Just put them into `rodbot/plugins/my_plugin/lib/` and use `require_relative` where you need them.
521521

522-
### Create Plugins
522+
### Create plugins
523523

524524
You can create plugins in any of the following places:
525525

@@ -529,7 +529,7 @@ You can create plugins in any of the following places:
529529

530530
Please adhere to common naming conventions and use the dashed prefix `rodbot-` (and Module `Rodbot`), however, underscores in case the remaining gem name consists of several words.
531531

532-
#### App Extension
532+
#### App extension
533533

534534
An app extension `rodbot/plugins/my_plugin/app.rb` defines the module `App` and looks something like this:
535535

@@ -569,7 +569,7 @@ The `App` module can be used to [extend all aspects of Roda](https://github.com/
569569

570570
For an example, take a look at the [:hal plugin](https://github.com/svoop/rodbot/tree/main/lib/rodbot/plugins/hal).
571571

572-
#### Relay Extension
572+
#### Relay extension
573573

574574
A relay extension `rodbot/plugins/my_plugin/relay.rb` defines the class `Relay` and looks something like this:
575575

@@ -610,7 +610,7 @@ Proactive messages require other parts of Rodbot to forward a message directly.
610610

611611
For an example, take a look at the [:matrix plugin](https://github.com/svoop/rodbot/tree/main/lib/rodbot/plugins/matrix).
612612

613-
#### Schedule Extension
613+
#### Schedule extension
614614

615615
A schedule extension `rodbot/plugins/my_plugin/schedule.rb` defines the class `Schedule` and looks something like this:
616616

@@ -647,7 +647,7 @@ Before you write a plugin, familiarise yourself with the following bundled helpe
647647
* [Rodbot::Refinements](https://www.rubydoc.info/gems/rodbot/Rodbot/Refinements.html) – just a few handy extensions to Ruby core classes
648648
* [Rodbot::Memoize](https://www.rubydoc.info/gems/rodbot/Rodbot/Memoize.html) – environment-aware memoization for method return values
649649

650-
## Environment Variables
650+
## Environment variables
651651

652652
Environment variables are used for the configuration bits which cannot or should not be part of `config/rodbot.rb` mainly because they have to be set on the infrastructure level.
653653

@@ -677,4 +677,3 @@ export RODBOT_SPEC_REDIS_URL=redis://localhost:6379/10
677677
```
678678

679679
You're welcome to join the [discussion forum](https://github.com/svoop/rodbot/discussions) to ask questions or drop feature ideas, [submit issues](https://github.com/svoop/rodbot/issues) you may encounter or contribute code by [forking this project and submitting pull requests](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
680-

lib/rodbot/plugins/github_webhook/README.github_webhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rodbot Plugin – GitHub Webhook
1+
# Rodbot plugin – GitHub webhook
22

33
Pipeline event announcements from GitHub
44

lib/rodbot/plugins/gitlab_webhook/README.gitlab_webhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rodbot Plugin – GitLab Webhook
1+
# Rodbot plugin – GitLab webhook
22

33
Pipeline event announcements from GitLab
44

lib/rodbot/plugins/hal/README.hal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rodbot Plugin – HAL 9000
1+
# Rodbot plugin – HAL 9000
22

33
Feel like Dave
44

lib/rodbot/plugins/matrix/README.matrix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rodbot Plugin – Matrix
1+
# Rodbot plugin – Matrix
22

33
Relay with the Matrix communication network
44

lib/rodbot/plugins/otp/README.otp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rodbot Plugin – OTP
1+
# Rodbot plugin – OTP
22

33
Guard commands with one-time passwords
44

lib/rodbot/plugins/slack/README.slack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rodbot Plugin – Slack
1+
# Rodbot plugin – Slack
22

33
Relay with the Slack communication network
44

lib/rodbot/plugins/word_of_the_day/README.word_of_the_day.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rodbot PluginWord of the Day
1+
# Rodbot pluginword of the day
22

33
Word of the day announcements
44

@@ -37,4 +37,3 @@ Word of the day: foobar (English) / foobâr (French) / foobår (Swedish)
3737
```
3838

3939
In case the word of the day is not available, the message will contain the missing language struck through.
40-

0 commit comments

Comments
 (0)