From b6ccf093cdeeed34378d304acf3fc10bbc6a5abe Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Tue, 9 Jul 2024 18:17:19 +0800 Subject: [PATCH] docs(readme): update readme --- README.md | 35 ++++++++++++++++------------------- 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index d2a9c045c..1033fe130 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,26 @@

- + SpaceVim

-[Quick Start Guide](https://spacevim.org/quick-start-guide/) \| -[FAQ](https://spacevim.org/faq/) +[![matrix](https://img.spacevim.org/spacevim-matrix.svg)](https://app.element.io/#/room/#spacevim:matrix.org) +[![Telegram](https://img.spacevim.org/telegram-spacevim.svg)](https://t.me/SpaceVim/) +[![twitter](https://img.spacevim.org/twitter.svg)](https://twitter.com/SpaceVim) +[![GPLv3 License](https://img.spacevim.org/license-GPLv3-blue.svg)](development/#license) +[![reddit](https://img.spacevim.org/reddit.svg)](https://www.reddit.com/r/SpaceVim/) -[![build](https://img.shields.io/github/actions/workflow/status/SpaceVim/SpaceVim/check.yml?branch=master)](https://github.com/SpaceVim/SpaceVim/actions/workflows/check.yml?query=branch%3Amaster) -[![Codecov coverage](https://img.shields.io/codecov/c/github/SpaceVim/SpaceVim.svg)](https://codecov.io/gh/SpaceVim/SpaceVim) -[![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE) -[![Docker Pulls](https://img.shields.io/docker/pulls/spacevim/spacevim)](https://hub.docker.com/r/spacevim/spacevim) +![work-flow](https://img.spacevim.org/workflow.png) -SpaceVim is a (neo)vim configuration inspired by spacemacs. +SpaceVim is a modular configuration of Vim and Neovim. +It's inspired by spacemacs. It manages collections of plugins in layers, +which help to collect related packages together to provide features. +This approach helps keep the configuration organized and reduces +overhead for the user by keeping them from having to think about +what packages to install. -## Features - -- **Modularization:** plugins and functions are organized in [layers](https://spacevim.org/layers/). -- **Compatible api:** a series of [compatible APIs](https://spacevim.org/api/) for Vim/Neovim. -- **Great documentation:** online [documentation](https://spacevim.org/documentation/) and `:h SpaceVim`. -- **Better experience:** [Use lua to implement core plugins](https://spacevim.org/use-lua-to-reimplement-core-plugins/) -- **Beautiful UI:** you'll love the awesome UI and its useful features. -- **Mnemonic key bindings:** key binding guide will be displayed automatically -- **Fast boot time:** Lazy-load 90% of plugins with [dein.vim](https://github.com/Shougo/dein.vim) -- **Lower the risk of RSI:** by heavily using the space bar instead of modifiers. -- **Consistent experience:** consistent experience between terminal and gui +- [Quick start guide](https://spacevim.org/quick-start-guide/): installation, configuration, and learning resources for SpaceVim +- [Documentation](https://spacevim.org/documentation/): the primary official documentation of SpaceVim +- [Available layers](https://spacevim.org/layers/): a list of available layers which can be used in SpaceVim