Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ttytm committed Apr 27, 2024
1 parent aee5e59 commit 44d6f3b
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ return { "LintaoAmons/bookmarks.nvim",
config = function ()
require("bookmarks").setup( {
json_db_path = vim.fs.normalize(vim.fn.stdpath("config") .. "/bookmarks.db.json"),
signs = {
mark = { icon = "", color = "grey" },
},
})
end
}
Expand All @@ -49,12 +52,12 @@ return { "LintaoAmons/bookmarks.nvim",

There's two concepts in this plugin: `BookmarkList` and `Bookmark`. You can look into the code to find the structure of those two domain objects

| Command | Description |
|-----------------------------------|-------------------------------------------------------------------------------------------------------------|
| `BookmarksMark` | Mark current line into active BookmarkList. |
| `BookmarksGoto` | Go to bookmark at current active BookmarkList |
| `BookmarksCommands` | Find and trigger a bookmark command. |
| `BookmarksGotoRecent` | Go to latest visited/created Bookmark |
| Command | Description |
| --------------------- | --------------------------------------------- |
| `BookmarksMark` | Mark current line into active BookmarkList. |
| `BookmarksGoto` | Go to bookmark at current active BookmarkList |
| `BookmarksCommands` | Find and trigger a bookmark command. |
| `BookmarksGotoRecent` | Go to latest visited/created Bookmark |

<details>
<summary>Commands we have right now</summary>
Expand Down Expand Up @@ -113,7 +116,7 @@ You can contact with me by drop me an email or [telegram](https://t.me/+ssgpiHyY
- [ ] refactor: extract picker module
- [ ] Telescope as default picker and will fallback to vim.ui if don't have telescope dependencies
- [x] telescope enhancement (use specific command instead)
- [ ] Recent files as bookmarks: record all the buffer the user recently opened and sort by the visited_at
- [ ] Recent files as bookmarks: record all the buffer the user recently opened and sort by the visited_at
- [x] A new command to create bookmark and put it into specific bookmark list (instead current active one)
- [ ] goto next/prev bookmark in the current buffer

Expand Down

0 comments on commit 44d6f3b

Please sign in to comment.