Skip to content

Commit

Permalink
doc: adjust README slightly
Browse files Browse the repository at this point in the history
  • Loading branch information
j-hui committed Dec 25, 2023
1 parent 1ba4ed7 commit b641654
Show file tree
Hide file tree
Showing 3 changed files with 389 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ For instance, using [Lazy](https://github.com/folke/lazy.nvim):

## Options

Fidget can be configured by passing a table of options to the `setup()`.
Available options are shown below:

```lua
{
-- Options related to LSP progress subsystem
Expand Down Expand Up @@ -261,10 +264,14 @@ source code. You are encouraged to hack around with that.

## Highlights

Rather than defining its own highlights, Fidget uses built-in highlight groups
that are typically overridden by custom Vim color schemes. With any luck, these
will look reasonable when rendered, but the visual outcome will really depend
on what your color scheme decided to do with those highlight groups.
Rather than defining its own highlights, Fidget's default configuration uses
built-in highlight groups that are typically overridden by custom Vim color
schemes. With any luck, these will look reasonable when rendered, but the visual
outcome will really depend on what your color scheme decided to do with those
highlight groups.

You can override these highlight groups (e.g., `icon_style`) using the `:h
fidget-options` shown above.

## Related Work

Expand Down
2 changes: 2 additions & 0 deletions lua/fidget.lua
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ fidget.progress = require("fidget.progress")
fidget.notification = require("fidget.notification")
fidget.spinner = require("fidget.spinner")
fidget.logger = require("fidget.logger")
local commands = require("fidget.commands")

--- Set up Fidget plugin.
---
Expand All @@ -38,6 +39,7 @@ fidget.options = {
---@options ]]

require("fidget.options").declare(fidget, "", fidget.options, function(warn_log)
commands.setup()
if fidget.options.notification.override_vim_notify then
fidget.logger.info("overriding vim.notify() with fidget.notify()")
vim.notify = fidget.notify
Expand Down
Loading

0 comments on commit b641654

Please sign in to comment.