Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vyfor committed Dec 10, 2024
1 parent 965ee86 commit 243898a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 3 additions & 3 deletions wiki/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ require('cord').setup {

## 🧩 Variables

| Option | Type | Default | Description |
| ----------- | ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `variables` | `table` | `nil` | Define [custom variables](#custom-variables) for use in string templates. Functions can be used to dynamically generate values. |
| Option | Type | Default | Description |
| ----------- | ------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `variables` | `table \| boolean \| nil` | `nil` | Define [custom variables](#custom-variables) for use in string templates. Functions can be used to dynamically generate values. If `true`, uses the default [options table](#options-table), if `table`, extends the default table, if `false`, disables custom variables |

## 🪝 Hooks

Expand Down
4 changes: 3 additions & 1 deletion wiki/MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,13 @@ idle = {
ignore_focus = true, -- Ignore window focus for idle state
}

variables = {} -- Define custom variables for use in string templates

hooks = {
on_ready = function() end, -- Server connection established
on_update = function(opts) end, -- Before building the activity
on_activity = function(opts, activity) end, -- Before sending the activity
on_idle = function(state) end, -- Entered idle state
on_idle = function(opts) end, -- Entered idle state
on_workspace_change = function(opts) end, -- Workspace directory changed
on_disconnect = function() end, -- Server disconnected
}
Expand Down

0 comments on commit 243898a

Please sign in to comment.