Merge branch 'master' of github.com:fcancelinha/northern.nvim

README.md

@@ -1,4 +1,6 @@
-<h1 align="center">Northern.nvim❄️ </h1>
+<h1 align="center">
+    Nordern.nvim❄️ 
+</h1>
 
 <div align="center">
     A carefully crafted nord colorscheme written in lua for neovim using the <a href="https://www.nordtheme.com/docs/colors-and-palettes">Nord Palette</a>.
@@ -7,27 +9,26 @@
 
 
 ![dashboard](https://github.com/user-attachments/assets/8bd142a5-6bd5-4c72-9564-7862aa677563)
-
 ![golang](https://github.com/user-attachments/assets/9b9cada4-5258-426c-93b9-1d9a4db3762e)
-
-![main](https://github.com/fcancelinha/northern.nvim/assets/48698009/740b04e3-7a20-4c92-9a00-2dc5e4eb4a25)
+![main](https://github.com/fcancelinha/nordern.nvim/assets/48698009/740b04e3-7a20-4c92-9a00-2dc5e4eb4a25)
 
 <div align="center">
 
-**Northern.nvim** | because like any good viking that loves gold, this colorscheme uses aurora yellow to highlight some of the more important tokens.
-
-**WARNING** ⚠️: this plugin is still very much a WIP, bufferline support exists but I'm figuring out the best way to implement it, some noice windows lack button background and I'm working on it
+**Nordern.nvim** | because like any good viking that loves gold, this colorscheme uses aurora yellow to highlight some of the more important tokens.
+</div>
 
+<div align="center">
+    WARNING ⚠️: this plugin is still very much a WIP, the name has been changed from Northern => Nordern for better exposure
 </div>
 
 ## Screenshots
 
 <details>
   <summary>more screenshots</summary>
 
-![2123](https://github.com/fcancelinha/northern.nvim/assets/48698009/7508095f-6411-4a89-9fc5-ffb85afd447b)
+![2123](https://github.com/fcancelinha/nordern.nvim/assets/48698009/7508095f-6411-4a89-9fc5-ffb85afd447b)
 
-![3424324](https://github.com/fcancelinha/northern.nvim/assets/48698009/935a4db6-dcae-4e07-9923-8529234d51aa)
+![3424324](https://github.com/fcancelinha/nordern.nvim/assets/48698009/935a4db6-dcae-4e07-9923-8529234d51aa)
 
 </details>
 
@@ -106,17 +107,17 @@ use your favourite package manager:
 
 - [Lazy](https://github.com/folke/lazy.nvim)
 ```lua
-{ "fcancelinha/northern.nvim", branch = "master", priority = 1000 }
+{ "fcancelinha/nordern.nvim", branch = "master", priority = 1000 }
 ```
 
 - [Vim-plug](https://github.com/junegunn/vim-plug)
 ```vim
-Plug 'fcancelinha/northern.nvim'
+Plug 'fcancelinha/nordern.nvim'
 ```
 
 - [Packer](https://github.com/wbthomason/packer.nvim)
 ```lua
-use {'fcancelinha/northern.nvim'}
+use {'fcancelinha/nordern.nvim'}
 ```
 
 ## ⛵ Use
@@ -125,21 +126,21 @@ Make sure to place this at the end of your configuration to avoid overwriting.
 
 ```lua
 -- Lua
-vim.cmd.colorscheme('northern')
+vim.cmd.colorscheme('nordern')
 ```
 ```vim
 " Vim-Script
-colorscheme northern
+colorscheme nordern
 ```
 
-To enable `northern` for `Lualine` or `Bufferline`, :
+To enable `nordern` for `Lualine`:
 
 #### Lualine
 
 ```lua
 require('lualine').setup {
   options = {
-    theme = 'northern'
+    theme = 'nordern'
     (...)
   },
 }
@@ -149,6 +150,19 @@ require('lualine').setup {
 
 - This has been integrated directly into the colorscheme, override the colors you don't like in your plugin config.
 
+## 🔧 Configuration
+
+- The available options currently, are:
+
+```lua
+# default configuration
+
+require('nordern').setup({
+    italicized_comments = Boolean,
+    brighter_comments = Boolean,
+})
+```
+
 ## 💧 Acknowledgements
 
 This is my first try at making a neovim plugin. I want to thank [shaunsign](https://github.com/shaunsingh) nord.nvim which made me understand how to setup my own plugin project structure and [gbprod](https://github.com/gbprod) for the blending functions that produce a soft background.