X-Git-Url: http://git.lukelau.me/?p=lsp-test.git;a=blobdiff_plain;f=README.md;h=b49ba8409950c3e7fff1e007701a506a28a28c0f;hp=4a8762be7cf90bf11cb298fec70e1025362aed00;hb=133940df94b1e8745598699a492e5c9534644d75;hpb=5ad934c026bf88521199d1e82aa12fe51626b92f

diff --git a/README.md b/README.md
index 4a8762b..b49ba84 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-# haskell-lsp-test [![Build Status](https://travis-ci.com/Bubba/haskell-lsp-test.svg?branch=master)](https://travis-ci.com/Bubba/haskell-lsp-test)
-haskell-lsp-test is a functional testing framework for Language Server Protocol servers.
+# lsp-test [![Actions Status](https://github.com/bubba/lsp-test/workflows/Haskell%20CI/badge.svg)](https://github.com/bubba/lsp-test/actions) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test)
+lsp-test is a functional testing framework for Language Server Protocol servers.
 
 ```haskell
 import Language.Haskell.LSP.Test
-runSession "hie" fullCaps "proj/dir" $ do
+main = runSession "hie" fullCaps "proj/dir" $ do
   doc <- openDoc "Foo.hs" "haskell"
   skipMany anyNotification
   symbols <- getDocumentSymbols doc
@@ -24,7 +24,7 @@ describe "diagnostics" $
 
 ### Replaying captured session
 ```haskell
-replaySession "hie --lsp" "test/data/renamePass"
+replaySession "hie" "test/data/renamePass"
 ```
 
 ### Parsing with combinators
@@ -34,9 +34,20 @@ count 4 (message :: Session ApplyWorkspaceEditRequest)
 anyRequest <|> anyResponse
 ```
 
-For more examples check the [Wiki](https://github.com/Bubba/haskell-lsp-test/wiki/Introduction)
+Try out the example tests in the `example` directory with `cabal test`.
+For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction).
+
+Whilst writing your tests you may want to debug them to see what's going wrong.
+You can set the `logMessages` and `logStdErr` options in `SessionConfig` to see what the server is up to.
+There are also corresponding environment variables so you can turn them on from the command line:
+```
+LSP_TEST_LOG_MESSAGES=1 cabal test
+```
 
 ## Developing
-To test make sure you have the following language servers installed:
-- [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine)
-- [javascript-typescript-langserver](https://github.com/sourcegraph/javascript-typescript-langserver)
+The tests for lsp-test use a dummy server found in `test/dummy-server/`.
+Run the tests with `cabal test` or `stack test`.
+Tip: If you want to filter the tests, use `cabal run test:tests -- -m "foo"`
+
+## Troubleshooting
+Seeing funny stuff when running lsp-test via stack? If your server is built upon Haskell tooling, [keep in mind that stack sets some environment variables related to GHC, and you may want to unset them.](https://github.com/alanz/haskell-ide-engine/blob/bfb16324d396da71000ef81d51acbebbdaa854ab/test/utils/TestUtils.hs#L290-L298)