Skip to content

Commit

Permalink
Prepare for 1.0.0 with a changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
fnune committed Mar 8, 2024
1 parent e809918 commit d1cca30
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 15 deletions.
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Changelog

All notable changes to Recall will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.0](<(https://github.com/fnune/recall.nvim/releases/tag/1.0.0)>) - 2024-03-08

### Added

Initial release of Recall.

- Basic global mark management with `:Recall{Toggle,Mark,Unmark}` and
`:RecallClear`
- Basic global mark navigation with `:Recall{Next,Previous}`
- Sign column with a customizable character
- Support for Neovim 0.10.x and also 0.9.x and lower
- Telescope integration beyond the built-in `:Telescope marks` that allows mark
deletion and displaying only global marks
- Improved stability by adding CI and testing using [plenary][plenary-tests]

[plenary-tests]: https://github.com/nvim-lua/plenary.nvim/blob/master/TESTS_README.md
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ _Telescope integration using `:Telescope recall theme=ivy`._

<!-- vim-markdown-toc GFM -->

* [Planned features](#planned-features)
* [Installation](#installation)
* [Telescope integration](#telescope-integration)
* [The `wshada` option](#the-wshada-option)
Expand All @@ -40,20 +39,6 @@ _Telescope integration using `:Telescope recall theme=ivy`._

<!-- vim-markdown-toc -->

## Planned features

- [x] Basic global mark management with `:Recall{Toggle,Mark,Unmark}` and
`:RecallClear`
- [x] Basic global mark navigation with `:Recall{Next,Previous}`
- [x] Sign column with a customizable character
- [x] Support for Neovim 0.10.x and also 0.9.x and lower
- [x] Telescope integration beyond the built-in `:Telescope marks` that allows
mark deletion and displaying only global marks
- [ ] Improved stability by adding CI and testing using
[plenary][plenary-tests]

[plenary-tests]: https://github.com/nvim-lua/plenary.nvim/blob/master/TESTS_README.md

## Installation

Recall requires no configuration:
Expand Down Expand Up @@ -115,6 +100,7 @@ vim.keymap.set("n", "<leader>ml", ":Telescope recall<CR>", { noremap = true, sil
```lua
{
"fnune/recall.nvim",
version = "^1.0.0",
config = function()
local recall = require("recall")

Expand Down

0 comments on commit d1cca30

Please sign in to comment.