Formatting

Author: uloco

README.md

@@ -1,4 +1,4 @@
-# Bluloco.nvim 
+# Bluloco.nvim
 
 A fancy but yet sophisticated light and dark designer neovim theme built with [lush.nvim](https://github.com/rktjmp/lush.nvim).
 It features a much more comprehensive usage of syntax scopes and color
@@ -7,23 +7,24 @@ Most popular plugins are also supported, see _plugins_ (link)
 
 This theme also works very good when Apple's **Nightshift Mode** is activated.
 
-This is a port of the popular Visual Studio Code bluloco themes
-[light](https://github.com/uloco/theme-bluloco-light) and
-[dark](https://github.com/uloco/theme-bluloco-dark)
-
+This is a port of the popular Visual Studio Code Themes
+[Bluloco Light](https://github.com/uloco/theme-bluloco-light) and
+[Bluloco Dark](https://github.com/uloco/theme-bluloco-dark)
 
 ### Dark
-![dark](./screenshots/dark.png)
 
+![dark](./screenshots/dark.png)
 
 ### Light
+
 ![light](./screenshots/light.png)
 
 ## Features
-* Auto switching light & dark style
-* Configureable _transparency_ and _italics_
-* Exhaustive plugin support
-* Written in lua
+
+- Auto switching light & dark style
+- Configureable _transparency_ and _italics_
+- Exhaustive plugin support
+- Written in lua
 
 ## Plugins
 
@@ -54,19 +55,17 @@ Currently supported plugins are:
 - [notify](https://github.com/rcarriga/nvim-notify)
 - [alpha](https://github.com/goolord/alpha-nvim)
 
-
-
-
+<!--
+TODO:
 <details>
 <summary> Example config </summary>
 </details
-
-* Foldable with screenshots
-* Add needed config hereF
+- Foldable with screenshots
+- Add needed config hereF -->
 
 ## Install
 
-Install bluloco with [packer](https://github.com/wbthomason/packer.nvim): 
+Install Bluloco with [packer](https://github.com/wbthomason/packer.nvim):
 
 ```lua
 use {
@@ -75,13 +74,12 @@ use {
 }
 ```
 
-
-##  Usage
+## Usage
 
 Enable the colorscheme with defaults.
 
-> ⚠️   The `setup()` function is optional but please call it
-**before** you set the colorscheme if you want to adjust the config.
+> ⚠️ The `setup()` function is optional but please call it
+> **before** you set the colorscheme if you want to adjust the config.
 
 ```lua
 require("bluloco").setup({
@@ -93,8 +91,7 @@ require("bluloco").setup({
 vim.cmd('colorscheme bluloco')
 ```
 
-
-You can also  apply the style variant directly.  
+You can also apply the style variant directly.  
 These are especially helpful when switching in an already running vim session.
 
 ```vim
@@ -103,6 +100,7 @@ These are especially helpful when switching in an already running vim session.
 ```
 
 #### Lualine
+
 Make sure your lualine settings are set to auto:
 
 ```lua
@@ -116,29 +114,32 @@ require('lualine').setup {
 ## Config
 
 ### Style
+
 There are three styles you can configure here: `auto`, `dark` and `light`.  
 The `auto` setting is the default and will adjust automatically to your
 `vim.o.background` value. If you change this value during runtime, it will also adjust accordingly.
 
->ℹ️   The style value only applys if you set the theme with `vim.cmd('colorscheme bluloco')`.  
-> Setting the theme with a variant directly will override this setting.  
+> ℹ️ The style value only applies if you set the theme with `vim.cmd('colorscheme bluloco')`.  
+> Setting the theme with a variant directly will override this setting.
 
 ### Transparency
+
 This setting will disable the background and use the default background of your terminal.
-You need to enable this if you want the terminal to be transparent. You would still need to 
+You need to enable this if you want the terminal to be transparent. You would still need to
 configure your terminal accordingly for light and dark backgrounds when switching often.
 
-See: auto switching themes.
-See: bluloco theme for iTerm2
+<!-- TODO:  See: auto switching themes.
+See: bluloco theme for iTerm2 -->
 
 ### Italics
+
 This setting will enable italics for _keywords_, _comments_ and _markup attributes_.
 
 <!-- ## Recipes
 ### Auto switching light & dark themes
  -->
 
 ## Contributing
-I'd be more than happy for any bugs you find and add an [issue](https://github.com/uloco/bluloco.nvim/issues).  
-Pull requests are also heartly welcome especially for missing plugin support.
 
+I'd be more than happy for any bugs you find and add an [issue](https://github.com/uloco/bluloco.nvim/issues).  
+Pull requests are warmly welcome especially for missing plugin support.