Skip to content

Commit 3a00f41

Browse files
committed
docs: update the guides
1 parent 651e177 commit 3a00f41

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

wiki/CONFIGURATION.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ require('cord').setup {
7575
update = 'fetch',
7676
pipe_path = nil,
7777
executable_path = nil,
78-
timeout = 60000,
78+
timeout = 300000,
7979
},
8080
discord = {
8181
reconnect = {
@@ -164,7 +164,7 @@ require('cord').setup {
164164
| `advanced.server.update` | `string` | `'fetch'` | Default way to acquire the server executable either if the executable is not found or a manual update is requested: `'fetch'` - fetch from GitHub, `'build'` - build from source, `'none'` - no-op |
165165
| `advanced.server.pipe_path` | `string \| nil` | `nil` | Custom IPC pipe path |
166166
| `advanced.server.executable_path` | `string \| nil` | `nil` | Custom server executable path |
167-
| `advanced.server.timeout` | `number` | `60000` | Server shutdown timeout (ms) |
167+
| `advanced.server.timeout` | `number` | `300000` | Server shutdown timeout (ms) |
168168
| `advanced.discord.reconnect.enabled` | `boolean` | `true` | Whether reconnection is enabled. Has minimal impact on performance. |
169169
| `advanced.discord.reconnect.interval` | `number` | `5000` | Reconnection interval in milliseconds, 0 to disable |
170170

@@ -335,14 +335,15 @@ The `ActivityManager` contains useful methods:
335335

336336
### Activity Options
337337

338-
| Parameter | Type | Description |
339-
| ------------ | -------- | ---------------------------------------------------------------------------------------------------- |
340-
| `type` | `number` | One of 'playing', 'listening', 'watching' |
341-
| `state` | `string` | The user's current state (e.g., "Editing a file"). |
342-
| `details` | `string` | Detailed information about what the user is doing. |
343-
| `timestamps` | `table` | Contains `start` and `end` timestamps for the activity. |
344-
| `assets` | `table` | Defines images and tooltips, including `large_image`, `large_text`, `small_image`, and `small_text`. |
345-
| `buttons` | `array` | Array of objects, each with `label` and `url`, defining interactive buttons in the presence. |
338+
| Parameter | Type | Description |
339+
| ------------ | --------- | ---------------------------------------------------------------------------------------------------- |
340+
| `type` | `number` | One of 'playing', 'listening', 'watching' |
341+
| `state` | `string` | The user's current state (e.g., "Editing a file"). |
342+
| `details` | `string` | Detailed information about what the user is doing. |
343+
| `timestamps` | `table` | Contains `start` and `end` timestamps for the activity. |
344+
| `assets` | `table` | Defines images and tooltips, including `large_image`, `large_text`, `small_image`, and `small_text`. |
345+
| `buttons` | `array` | Array of objects, each with `label` and `url`, defining interactive buttons in the presence. |
346+
| `is_idle` | `boolean` | Whether the activity should be considered as idle. |
346347

347348
### Useful Functions
348349

wiki/MIGRATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The plugin in question, **cord.nvim**, has been rewritten from scratch with a ne
1212

1313
- A new smart idle system has been implemented - you're only shown as idle when all your Neovim instances are actually idle. When an instance goes idle, it automatically switches back to show your most recent active one.
1414

15-
- The plugin is now event-driven, meaning changes are reflected instantly without any polling delays. When all instances disconnect, the server, as well as the connection to Discord, stay alive for a minute (configurable) before shutting down, which helps to avoid rate limiting issues.
15+
- The plugin is now event-driven, meaning changes are reflected instantly without any polling delays. When all instances disconnect, the server, as well as the connection to Discord, stay alive for a little while (configurable) before shutting down, which helps to avoid rate limiting issues.
1616

1717
- A new `variables` option allows users to define custom variables, including functions, for dynamic text templates. This enhances the flexibility and customization of the Rich Presence display.
1818

0 commit comments

Comments
 (0)