docs: added README

README.md

@@ -0,0 +1,85 @@
+
+# 🏙 Tokyo Night
+
+A dark Neovim theme written in Lua ported from the Visual Studio Code [TokyoNight](https://github.com/enkia/tokyo-night-vscode-theme) theme.
+
+## ✨ Features
+
++ [TreeSitter](https://github.com/nvim-treesitter/nvim-treesitter)
++ [LSP Diagnostics](https://neovim.io/doc/user/lsp.html)
++ [LSP Saga](https://github.com/glepnir/lspsaga.nvim)
++ [Git Signs](https://github.com/lewis6991/gitsigns.nvim)
++ [Git Gutter](https://github.com/airblade/vim-gitgutter)
++ [Telescope](https://github.com/nvim-telescope/telescope.nvim)
++ [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)
++ [WhichKey](https://github.com/liuchengxu/vim-which-key)
++ [Indent Blankline](https://github.com/lukas-reineke/indent-blankline.nvim)
++ [Dashboard](https://github.com/glepnir/dashboard-nvim)
++ [BufferLine](https://github.com/akinsho/nvim-bufferline.lua)
++ a TokyNight [Lualine](https://github.com/hoob3rt/lualine.nvim) theme is included
+
+## 📦 Installation
+
+Install the theme with your preferred package manager:
+
+[vim-plug](https://github.com/junegunn/vim-plug)
+
+```vim
+Plug 'folke/tokyonight.nvim'
+```
+
+[packer](https://github.com/wbthomason/packer.nvim)
+
+```lua
+use 'folke/tokyonight.nvim'
+```
+
+## 🚀 Usage
+
+Enable the colorscheme:
+
+```vim
+" Vim Script
+colorscheme tokyonight
+```
+
+```lua
+-- Lua
+vim.cmd[[colorscheme tokyonight]]
+```
+
+To enable the `TokyoNight` theme for `Lualine`, simply specify it in your lualine settings:
+
+```lua
+require('lualine').setup {
+  -- ... your lualine config
+  theme = 'tokyonight'
+  -- ... your lualine config
+}
+```
+
+## ⚙️ Configuration
+
+The theme comes in two styles, `storm` and a darker variant `night`.
+
+```lua
+-- The theme comes in two styles, "storm" and a darker variant "night".
+vim.g.tokyonight_style = "storm"
+
+-- Comments are italicized by default
+vim.g.tokyonight_italic_comments = true
+
+-- Keywords are italicized by default
+vim.g.tokyonight_italic_keywords = true
+
+-- Functions are not italicized by default
+vim.g.tokyonight_italic_functions = false
+
+-- Enable this to disable setting the background color
+vim.g.tokyonight_transparent = false
+
+-- Enabling this option, will hide inactive statuslines and
+-- replace them with a thin border instead. Should work with
+-- the standard `StatusLine` and `LuaLine`.
+vim.g.tokyonight_hide_inactive_statusline = true
+```