✍️ Changelogs & Minimal config example

CHANGELOG.md

@@ -9,16 +9,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- `Linting` Github Action init
-- `Makefile, .lua-format, .luacheckrc` init
-- format .lua code with (lua-format)[https://github.com/Koihik/LuaFormatter]
-- `kitty` tabs color changed
-- onedark setting using `reqiure("onedark.config")` [monsonjeremy/onedark.nvim#5]
+- **Warning** on `vim.g` configuration
+- Configure plugin in lua using `require('onedark').setup({})` **[fix monsonjeremy/onedark.nvim#5]**
+- Minimal config example added inside [README.md#minimal](./README.md#minimal)
+- Linting Github Action init
+- Format .lua code with [lua-format](https://github.com/Koihik/LuaFormatter)
+- **kitty tab** colors are changed
+- Init: `Makefile, .lua-format, .luacheckrc`
 
 ### Changed
 
+- Removed function `require('onedark').colorscheme()`
+- Colorscheme **autoload removed** from `colors/onedark.vim`
 - **VertSplit** & **Inactive StatusLine** `fg` color changed to `bg_visual`
-- configuration docs updated inside README.md
+- StatusLine bug note inside [README.md#usage](./README.md#-usage)
+- Configuration docs updated inside [README.md#configuration](./README.md#-configuration)
 
 ## [v0.0.1] - 14 June 2021
 

Makefile

@@ -10,6 +10,6 @@ format:
 	@for file in `find . -name '*.lua'`;do lua-format $$file -i; done;
 
 lint: $(onedark_path)
-	@luacheck $(onedark_path) --config .luacheckrc
+	@luacheck $(onedark_path)
 
 check: format lint

README.md

@@ -1,13 +1,19 @@
+<!-- Branding -->
 <p align="center">
-    <img src="https://i.imgur.com/lNdBu1v.png" alt="onedark.nvim" />
+  <img src="https://i.imgur.com/lNdBu1v.png" alt="onedark.nvim" />
+  <br />
+  Atom's iconic One Dark theme for Neovim, written in Lua
 </p>
 
+<!-- Badges -->
 <p align="center">
-    Atom's iconic One Dark theme for Neovim, written in Lua
-</p>
-
-<p align="center">
-    De-attach fork of <b><a href="https://github.com/monsonjeremy/onedark.nvim">monsonjeremy/onedark.nvim</a></b>
+  <!-- First Row -->
+  <a href="https://github.com/monsonjeremy/onedark.nvim">
+    <img alt="monsonjeremy/onedark.nvim" src="https://img.shields.io/badge/Fork%20of-monsonjeremy%2Fonedark.nvim-blue" />
+  </a>
+  <a href="https://github.com/ful1e5/onedark.nvim/actions">
+    <img alt="GitHub Action Linting" src="https://github.com/ful1e5/onedark.nvim/actions/workflows/lint.yml/badge.svg" width="102" />
+  </a>
 </p>
 
 ## ✨ Features
@@ -151,7 +157,7 @@ set -as terminal-overrides ',*:Setulc=\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{25
 
 ## 🌈 Extras
 
-> To generate the configs `:luafile /lua/onedark/extra/init.lua`
+> To generate the configs `make extra`
 
 Extra color configs for **Kitty**, and **Alacritty** can be found in [extras](extras/). To use them, refer to their respective documentation.
 
@@ -205,6 +211,21 @@ require("onedark").setup({
     <img src="https://imgur.com/oA5PjUb.png" alt="Italic fonts" />
 </p>
 
+### Minimal
+
+```lua
+require("onedark").setup({
+  hideInactiveStatusline = true,
+  darkSidebar = false,
+  darkFloat = false
+  -- ... your onedark config
+})
+```
+
+<p align="center">
+    <img src="https://imgur.com/VSTW3Hr.png" alt="Minimal" />
+</p>
+
 ### Telescope
 
 <p align="center">
@@ -218,8 +239,6 @@ require("onedark").setup({
 - [Wallpaper](https://hdqwalls.com/big-sur-4k-wallpaper)
 - [dotfiles](https://github.com/ful1e5/dotfiles)
 
-<!-- Support -->
-
 ## Support
 
 <a href="https://www.buymeacoffee.com/Nt7Wg4V" >
@@ -231,7 +250,6 @@ require("onedark").setup({
 Follow me on **[Twitter](https://twitter.com/ful1e5)**
 
 <!-- Ninja  -->
-
 <p align="center">
   <h1 align="center">(◣_◢)</h1>
 </p>