diff --git a/CHANGELOG.md b/CHANGELOG.md index b0cbf556..3d4ecfea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,12 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [unreleased] +## [v0.0.7] - 16 January 2023 + ### Changes - merged: #222 - Fixed #214 #220 #223 #224 -## [v0.0.6] - 03 Aug 2022 +## [v0.0.6] - 03 August 2022 ### Changes @@ -72,7 +74,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - fix: skip native_autocmds on some neovim0.7 builds - fixed #179 -## [v0.0.4] - 11 Jan 2022 +## [v0.0.4] - 11 January 2022 ### Added @@ -116,7 +118,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fixed `iterm` theme generation - fix: lualine theme -## [v0.0.3] - 09 Dec 2021 +## [v0.0.3] - 09 December 2021 ### Added @@ -179,7 +181,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix `vim.o.background` setting in config module - Fix assign `user_config` value to `vim.g` global variables -## [v0.0.2] - 15 Sep 2021 +## [v0.0.2] - 15 September 2021 ### Added @@ -219,13 +221,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - use `bg_visiual` color as floating window border - use `bg` and `bg2` colors for `EndOfBuffer` `NoneText` fixed #66 -## [v0.0.1] - 09 Jul 2021 +## [v0.0.1] - 09 July 2021 ### Added - Initial release 🎊 -[unreleased]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.6...main +[unreleased]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.7...main +[v0.0.7]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.7...v0.0.6 [v0.0.6]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.6...v0.0.5 [v0.0.5]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.5...v0.0.4 [v0.0.4]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.4...v0.0.3 diff --git a/README.md b/README.md index d809412c..142a78aa 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Notices -> **Warning** +> **Note** > All features and bug fixes are on hold while we focus on a refactor of the theme. > If you would like to be involved in the > [discussion](https://github.com/projekt0n/github-nvim-theme/discussions/226) @@ -21,32 +21,31 @@ or `:h github-theme-changelog` to receive updates on breaking changes and deprec ## Installation +> **Warning** +> Use the latest release [tag](https://github.com/projekt0n/github-nvim-theme/releases/tag/v0.0.7) or +> [0.0.x](https://github.com/projekt0n/github-nvim-theme/tree/0.0.x) branch for updates, not the main branch. + Install the theme with your preferred package manager: Install with [vim-plug](https://github.com/junegunn/vim-plug): ```vim -Plug 'projekt0n/github-nvim-theme' +Plug 'projekt0n/github-nvim-theme', { 'tag': '0.0.7' } +" or { 'branch': '0.0.x' } ``` Or with [dein](https://github.com/Shougo/dein.vim): ```vim -call dein#add('projekt0n/github-nvim-theme') +call dein#add('projekt0n/github-nvim-theme', { 'rev': '0.0.7' }) +" or { 'rev': '0.0.x' } ``` Or with [minpac](https://github.com/k-takata/minpac): ```vim -call minpac#add('projekt0n/github-nvim-theme') -``` - -Or with [Vundle](https://github.com/vundlevim/vundle.vim): - -Place this in your `.vimrc` or `init.vim`, - -```vim -Plugin 'projekt0n/github-nvim-theme' +call minpac#add('projekt0n/github-nvim-theme', { 'rev': '0.0.7' }) +" or { 'rev': '0.0.x' } ``` Or with [Packer.nvim](https://github.com/wbthomason/packer.nvim): @@ -55,11 +54,13 @@ Add this in your `init.lua` or `plugins.lua` ```lua -- Install without configuration -use ({ 'projekt0n/github-nvim-theme' }) +use ({ 'projekt0n/github-nvim-theme', tag = '0.0.7' }) +-- or branch = '0.0.x' -- Or with configuration use({ - 'projekt0n/github-nvim-theme', + 'projekt0n/github-nvim-theme', tag = '0.0.7', +-- or branch = '0.0.x' config = function() require('github-theme').setup({ -- ...