[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/eglot 9d404c9 054/139: Update README.md

From: João Távora
Subject: [elpa] externals/eglot 9d404c9 054/139: Update README.md
Date: Mon, 14 May 2018 09:54:53 -0400 (EDT)

branch: externals/eglot
commit 9d404c98d7de60f02278cfd1ef84416792690169
Author: João Távora <address@hidden>
Commit: João Távora <address@hidden>

    Update README.md
 README.md | 40 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 38 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7a747fd..8809421 100644
--- a/README.md
+++ b/README.md
@@ -3,11 +3,47 @@ Eglot
 *E*macs Poly*glot*. An Emacs client to Language Server Protocol servers.
-Coming soon.
 (add-to-list 'load-path "/path/to/eglot")
 (require 'eglot)
 M-x eglot
+*That's it*. Either this guesses the local LSP program to start for
+the language of your choice or it prompts you for such a thing. You
+can also enter a `server:port` pattern to connect to an LSP server. To
+skip the guess and always be prompted use `C-u M-x eglot`.
+## Differences to lsp-mode.el
+This is really beta and currently does less than
+[lsp-mode.el](https://github.com/emacs-lsp/lsp-mode) which is more
+mature. Though I think `eglot.el` will eventually beat it, you could
+be better served with `lsp-mode.el` for now.
+User-visible differences:
+- Single entry point, `M-x eglot` to enable LSP in a project.
+  Automatically detects current and future opened files under that
+  project and syncs with server.
+- Easy way to restart a server
+- Pretty interactive mode-line section for live tracking of server
+  communication.
+Differences under the hood:
+- Message parser is much much simpler
+- Easier to read and maintain elisp. Yeah I know, subjective... But
+  judge for yourself.
+- No external dependencies apart from Emacs (no `flycheck.el`, no
+  `projectile.el`, no Cask, etc).
+- Uses project.el, flymake.el
+- Requires the upcoming emacs 26
+- Contained in one file
+- send `textDocument/didChange` for groups of edits, not one per each
+  tiny change. 
+- Its missing tests! This is *not good*

reply via email to

[Prev in Thread] Current Thread [Next in Thread]