Skip to content

Commit

Permalink
update README and add example config
Browse files Browse the repository at this point in the history
Now that CI is working, leave some notes for the dev environment.
  • Loading branch information
Robb Kidd committed Apr 16, 2022
1 parent 1697825 commit 4babea6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin system and many plugins already written.

## Installation

Make sure you have ruby 2.1 or greater, rubygems, and bundler installed.
Make sure you have ruby 2.7 or greater, rubygems, and bundler installed.

Then,

Expand All @@ -20,14 +20,16 @@ bundle install

That should set you up with linkbot and all its dependencies.

Next, copy `config.json.example` into `config.json`, and set the
appropriate variables. You must fill in the `connectors` field
with appropriate connection information, but feel free to delete
sections from the `plugins` section for plugins you don't want.
Next, copy `config.example.json` into `./tmp/config.json`, and set the
appropriate variables. You must fill in the `connectors` field with appropriate
connection information, but feel free to add or delete entries from the `plugins`
section for plugins you don't want. KEEP the `plugins` section, though, even if
it is empty.

(TODO: more on this, refactor config)

Finally, run `ruby linkbot.rb` to run linkbot.
Finally, run `linkbot --config ./tmp/config.json --database ./tmp/data.sqlite3`
to run linkbot.

## Connectors

Expand Down
11 changes: 11 additions & 0 deletions config.example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"connectors": [
{
"type": "slack",
"username": "devbot",
"token": "a_slack_bot_token",
"icon_url": "https://dl.dropboxusercontent.com/u/31927607/drawn%20companion%20cube.png"
}
],
"plugins": {}
}

0 comments on commit 4babea6

Please sign in to comment.