feat(readme): add theming docs

lua/cosmic/config/examples/config.lua

@@ -17,7 +17,13 @@ config.statusline = {
 -- see Cosmic defaults: core/treesitter/init.lua
 config.treesitter = {}
 
--- lsp Settings
+-- theming, don't forget to run :PackerSync and reload CosmicNvim when chaning themes
+-- 'Catppuccino.nvim'
+-- 'gruvbox.nvim'
+-- 'nord.nvim'
+config.theme = 'tokyonight.nvim' -- default
+
+-- lsp settings
 config.lsp = {
 
   -- true/false or table of filetypes {'.ts', '.js',}

lua/cosmic/config/init.lua

@@ -8,7 +8,7 @@ end
 -- these settings will be merged with any settings definined in config.lua
 local default_config = {
   -- theme = 'Catppuccino.nvim',
-  theme = 'gruvbox.nvim',
+  theme = 'tokyonight.nvim',
   lsp = {
     format_on_save = true, -- true/false or table of filetypes {'.ts', '.js',}
     rename_notification = true,

lua/cosmic/core/theme/colors.lua

@@ -2,16 +2,12 @@ local config = require('cosmic.config')
 local colors = {}
 
 if config.theme == 'tokyonight.nvim' then
-  print('loading tokyonight colors')
   colors = require('cosmic.core.theme.integrated.tokyonight')
 elseif config.theme == 'Catppuccino.nvim' then
-  print('loading catpuuccino colors')
   colors = require('cosmic.core.theme.integrated.catppuccin')
 elseif config.theme == 'gruvbox.nvim' then
-  print('loading gruvbox colors')
   colors = require('cosmic.core.theme.integrated.gruvbox')
 elseif config.theme == 'nord.nvim' then
-  print('loading nord colors')
   colors = require('cosmic.core.theme.integrated.nord')
 end
 

lua/cosmic/core/theme/integrated/gruvbox.lua

@@ -1,42 +1,3 @@
---[[ {
-  dark0_hard = hsl("#1d2021"),
-  dark0 = hsl("#282828"),
-  dark0_soft = hsl("#32302f"),
-  dark1 = hsl("#3c3836"),
-  dark2 = hsl("#504945"),
-  dark3 = hsl("#665c54"),
-  dark4 = hsl("#7c6f64"),
-  light0_hard = hsl("#f9f5d7"),
-  light0 = hsl("#fbf1c7"),
-  light0_soft = hsl("#f2e5bc"),
-  light1 = hsl("#ebdbb2"),
-  light2 = hsl("#d5c4a1"),
-  light3 = hsl("#bdae93"),
-  light4 = hsl("#a89984"),
-  bright_red = hsl("#fb4934"),
-  bright_green = hsl("#b8bb26"),
-  bright_yellow = hsl("#fabd2f"),
-  bright_blue = hsl("#83a598"),
-  bright_purple = hsl("#d3869b"),
-  bright_aqua = hsl("#8ec07c"),
-  bright_orange = hsl("#fe8019"),
-  neutral_red = hsl("#cc241d"),
-  neutral_green = hsl("#98971a"),
-  neutral_yellow = hsl("#d79921"),
-  neutral_blue = hsl("#458588"),
-  neutral_purple = hsl("#b16286"),
-  neutral_aqua = hsl("#689d6a"),
-  neutral_orange = hsl("#d65d0e"),
-  faded_red = hsl("#9d0006"),
-  faded_green = hsl("#79740e"),
-  faded_yellow = hsl("#b57614"),
-  faded_blue = hsl("#076678"),
-  faded_purple = hsl("#8f3f71"),
-  faded_aqua = hsl("#427b58"),
-  faded_orange = hsl("#af3a03"),
-  gray = hsl("#928374"),
-} ]]
-
 local theme = require('gruvbox.colors')
 local convert = require('lush.hsl.convert')
 

readme.md

@@ -27,7 +27,7 @@ Full featured native LSP functionality!
 
 ##### Additional features
 
-- Amazing colors thanks to [tokyonight.nvim](https://github.com/folke/tokyonight.nvim)
+- Amazing default theme thanks to [tokyonight.nvim](https://github.com/folke/tokyonight.nvim)
 - Enhanced syntax highlighting with [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
 - Dashboard via [dashboard-nvim](https://github.com/glepnir/dashboard-nvim)
 - Hand-built statusline with [galaxyline](https://github.com/NTBBloodbath/galaxyline.nvim)
@@ -70,6 +70,27 @@ Additional LSP server installation [details](https://github.com/mattleong/Cosmic
 
 CosmicNvim uninstallation [details](https://github.com/mattleong/CosmicNvim/wiki/Uninstalling-CosmicNvim).
 
+## Theming
+
+CosmicNvim comes with first-class support for the following themes:
+
+- [Catppuccino](https://github.com/Pocco81/Catppuccino.nvim)
+- [Gruvbox](https://github.com/ellisonleao/gruvbox.nvim)
+- [Nord](https://github.com/shaunsingh/nord.nvim)
+- [Tokyonight](https://github.com/folke/tokyonight.nvim)
+
+## Configuration
+
+[Cosmic configurations](./lua/cosmic/config/examples/config.lua)
+
+[Plugin configurations](./lua/cosmic/config/examples/plugins.lua)
+
+[Add additional mappings](./lua/cosmic/config/examples/mappings.lua)
+
+[Add additional vim options](./lua/cosmic/config/examples/editor.lua)
+
+[More info](./lua/cosmic/config/examples/readme.md)
+
 ## Cosmic Commands
 
 #### Update CosmicNvim
@@ -92,18 +113,6 @@ By default, this will assume the Cosmic git directory is placed at `vim.fn.stdpa
 :CosmicReload
 ```
 
-## Configuration
-
-[Cosmic configurations](./lua/cosmic/config/examples/config.lua)
-
-[Plugin configurations](./lua/cosmic/config/examples/plugins.lua)
-
-[Add additional mappings](./lua/cosmic/config/examples/mappings.lua)
-
-[Add additional vim options](./lua/cosmic/config/examples/editor.lua)
-
-[More info](./lua/cosmic/config/examples/readme.md)
-
 ## Treesitter Support
 
 Enter `:TSInstall` followed by <TAB> to see your options for additional language support.