Skip to content

README: no require users to call require 'neogit'.setup() #1643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 8, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -39,17 +39,7 @@ Here's an example spec for [Lazy](https://github.com/folke/lazy.nvim), but you'r
"ibhagwan/fzf-lua", -- optional
"echasnovski/mini.pick", -- optional
},
config = true
}

```

If you're not using lazy, you'll need to require and setup the plugin like so:

```lua
-- init.lua
local neogit = require('neogit')
neogit.setup {}
```

## Compatibility
@@ -58,7 +48,7 @@ The `master` branch will always be compatible with the latest **stable** release

## Configuration

You can configure neogit by running the `neogit.setup()` function, passing a table as the argument.
You can configure neogit by running the `require('neogit').setup {}` function, passing a table as the argument.

<details>
<summary>Default Config</summary>