From 5d2e362478d37202ad861a4c5665c5f96166d08e Mon Sep 17 00:00:00 2001 From: ashincoder <ashinant15@gmail.com> Date: Sun, 11 Jul 2021 19:46:22 +0530 Subject: [PATCH] Big update to README.md --- README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c30b6c..c3bbe05 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,75 @@ +<h1 align="center">StarVim</h1> + +<h6 align="center">A IDE wrapper which is beyond the moon 🌚 and above the stars ⭐ :O!</h1> + +</div> + +<div align="center"> + +[]() +<a href="https://github.com/ashincoder/StarVim" + ><img + src="https://img.shields.io/github/repo-size/ashincoder/StarVim?style=flat-square&label=Repo" + alt="GitHub repository size" + /></a> + <a href="https://github.com/ashincoder/StarVim/blob/main/LICENSE" + ><img + src="https://img.shields.io/github/license/ashincoder/StarVim?style=flat-square&logo=GNU&label=License" + alt="License" + /> +[](https://gitter.im/starvim-s-community/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) +[](https://github.com/neovim/neovim) +[](https://github.com/siduck76/StarVim/issues) +[](https://github.com/siduck76/StarVim/pulse) + + </div> + ## Installation `bash <(curl -s https://raw.githubusercontent.com/ashincoder/StarVim/main/bin/installer)` +## Update Config + +To keep the config up to date : + +``` +git pull +nvim +PackerCompile +``` + +> ! This will not affect your 'sv-config.lua'. So don't worry. + +# Features + +- Packer.nvim as package manager +- Nvim-treesitter for syntax highlighting +- LspInstall for installing lsp servers easily. +- Nvim-compe for autocompletion +- Lspkind to show pictograms on autocompletion items +- Using nvim-lsp +- Nvim-lspconfig for nvim-lps configuration +- Telescope for file finding, picking, previewing +- File navigation with Nvimtree +- Using plugins that are mouse friendly (Keyboard is better!) +- managing tabs, buffers with Bufferline +- Autosave functionality. +- Icons on nvimtree, telescope, bufferline/statusline and almost everywhere! with nvim-web-devicons +- Minimal status line (lualine) +- Gitsigns (colored bars for git in my config) +- Nvim-autopairs, for autolosing braces and stuffs +- Neoformat for prettifying / formatting code +- Indent-blankline.Nvim for indentlines +- Smooth scrolling with Neoscroll +- Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets) + +- And the Killer Feature ! []() + ## TODO This project is still a work in progress. But there won't be any breakage. -- [ ] Documentation +- [ ] Documentation, Wiki and stuff +- [ ] More Custom Colorschemes - [ ] Logo - [ ] Readme - [ ] Clean code +