Skip to content

Commit 24c8706

Browse files
committed
Warning: Use v0.0.7 or 0.0.x branch for updates, not main branch
As of this commit, it is recommended to use the latest release tag(v0.0.7) or the `0.0.x` branch for updates, rather than the main branch. This is due to ongoing refactoring of the color scheme. Additionally, the documentation for Vundle installation has been removed, as it no longer supports specific revisions or branches. For more information please refer to the installation documentation at the following link: https://github.com/projekt0n/github-nvim-theme#installation
1 parent 8dcfe1f commit 24c8706

File tree

2 files changed

+24
-20
lines changed

2 files changed

+24
-20
lines changed

CHANGELOG.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [unreleased]
99

10+
## [v0.0.7] - 16 January 2023
11+
1012
### Changes
1113

1214
- merged: #222
1315
- Fixed #214 #220 #223 #224
1416

15-
## [v0.0.6] - 03 Aug 2022
17+
## [v0.0.6] - 03 August 2022
1618

1719
### Changes
1820

@@ -72,7 +74,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7274
- fix: skip native_autocmds on some neovim0.7 builds
7375
- fixed #179
7476

75-
## [v0.0.4] - 11 Jan 2022
77+
## [v0.0.4] - 11 January 2022
7678

7779
### Added
7880

@@ -116,7 +118,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
116118
- Fixed `iterm` theme generation
117119
- fix: lualine theme
118120

119-
## [v0.0.3] - 09 Dec 2021
121+
## [v0.0.3] - 09 December 2021
120122

121123
### Added
122124

@@ -179,7 +181,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
179181
- Fix `vim.o.background` setting in config module
180182
- Fix assign `user_config` value to `vim.g` global variables
181183

182-
## [v0.0.2] - 15 Sep 2021
184+
## [v0.0.2] - 15 September 2021
183185

184186
### Added
185187

@@ -219,13 +221,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
219221
- use `bg_visiual` color as floating window border
220222
- use `bg` and `bg2` colors for `EndOfBuffer` `NoneText` fixed #66
221223

222-
## [v0.0.1] - 09 Jul 2021
224+
## [v0.0.1] - 09 July 2021
223225

224226
### Added
225227

226228
- Initial release 🎊
227229

228-
[unreleased]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.6...main
230+
[unreleased]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.7...main
231+
[v0.0.7]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.7...v0.0.6
229232
[v0.0.6]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.6...v0.0.5
230233
[v0.0.5]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.5...v0.0.4
231234
[v0.0.4]: https://github.com/projekt0n/github-nvim-theme/compare/v0.0.4...v0.0.3

README.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Notices
44

5-
> **Warning**
5+
> **Note**
66
> All features and bug fixes are on hold while we focus on a refactor of the theme.
77
> If you would like to be involved in the
88
> [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
2121

2222
## Installation
2323

24+
> **Warning**
25+
> Use the latest release [tag](https://github.com/projekt0n/github-nvim-theme/releases/tag/v0.0.7) or
26+
> [0.0.x](https://github.com/projekt0n/github-nvim-theme/tree/0.0.x) branch for updates, not the main branch.
27+
2428
Install the theme with your preferred package manager:
2529

2630
Install with [vim-plug](https://github.com/junegunn/vim-plug):
2731

2832
```vim
29-
Plug 'projekt0n/github-nvim-theme'
33+
Plug 'projekt0n/github-nvim-theme', { 'tag': '0.0.7' }
34+
" or { 'branch': '0.0.x' }
3035
```
3136

3237
Or with [dein](https://github.com/Shougo/dein.vim):
3338

3439
```vim
35-
call dein#add('projekt0n/github-nvim-theme')
40+
call dein#add('projekt0n/github-nvim-theme', { 'rev': '0.0.7' })
41+
" or { 'rev': '0.0.x' }
3642
```
3743

3844
Or with [minpac](https://github.com/k-takata/minpac):
3945

4046
```vim
41-
call minpac#add('projekt0n/github-nvim-theme')
42-
```
43-
44-
Or with [Vundle](https://github.com/vundlevim/vundle.vim):
45-
46-
Place this in your `.vimrc` or `init.vim`,
47-
48-
```vim
49-
Plugin 'projekt0n/github-nvim-theme'
47+
call minpac#add('projekt0n/github-nvim-theme', { 'rev': '0.0.7' })
48+
" or { 'rev': '0.0.x' }
5049
```
5150

5251
Or with [Packer.nvim](https://github.com/wbthomason/packer.nvim):
@@ -55,11 +54,13 @@ Add this in your `init.lua` or `plugins.lua`
5554

5655
```lua
5756
-- Install without configuration
58-
use ({ 'projekt0n/github-nvim-theme' })
57+
use ({ 'projekt0n/github-nvim-theme', tag = '0.0.7' })
58+
-- or branch = '0.0.x'
5959

6060
-- Or with configuration
6161
use({
62-
'projekt0n/github-nvim-theme',
62+
'projekt0n/github-nvim-theme', tag = '0.0.7',
63+
-- or branch = '0.0.x'
6364
config = function()
6465
require('github-theme').setup({
6566
-- ...

0 commit comments

Comments
 (0)