X-Git-Url: http://git.lukelau.me/?p=lsp-test.git;a=blobdiff_plain;f=README.md;h=8a16945bb5730b4f0be3d16c7755b411dd354c97;hp=b42dfcf81a7b6f4b4138e98028990b2e2a7ad3a2;hb=5cc69357da694c5521a78b0ab64866d76993de65;hpb=41ecc7bd7a4c9c92f966562bff4bfc2adbc20cff

diff --git a/README.md b/README.md
index b42dfcf..8a16945 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,48 @@
-# haskell-lsp-test
-This is the functional testing framework for [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine), and potentially any other Language Server Protocol server.
+# lsp-test [![Build Status](https://travis-ci.com/bubba/lsp-test.svg?branch=master)](https://travis-ci.com/bubba/lsp-test) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test-0.1.0.0)
+lsp-test is a functional testing framework for Language Server Protocol servers.
+
+```haskell
+import Language.Haskell.LSP.Test
+runSession "hie" fullCaps "proj/dir" $ do
+  doc <- openDoc "Foo.hs" "haskell"
+  skipMany anyNotification
+  symbols <- getDocumentSymbols doc
+```
+
+## Examples
+
+### Unit tests with HSpec
+```haskell
+describe "diagnostics" $
+  it "report errors" $ runSession "hie" fullCaps "test/data" $ do
+    openDoc "Error.hs" "haskell"
+    [diag] <- waitForDiagnosticsSource "ghcmod"
+    liftIO $ do
+      diag ^. severity `shouldBe` Just DsError
+      diag ^. source `shouldBe` Just "ghcmod"
+```
+
+### Replaying captured session
+```haskell
+replaySession "hie" "test/data/renamePass"
+```
+
+### Parsing with combinators
+```haskell
+skipManyTill loggingNotification publishDiagnosticsNotification
+count 4 (message :: Session ApplyWorkspaceEditRequest)
+anyRequest <|> anyResponse
+```
+
+Try out the example tests in the `example` directory with `cabal new-test`.
+For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction)
+
+## Developing
+The tests are integration tests, so make sure you have the following language servers installed and on your PATH:
+### [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine)
+- Check out a relatively recent version of the repo, or see `.travis.yml` to get the exact commit used for CI.
+- `stack install`
+### [javascript-typescript-langserver](https://github.com/sourcegraph/javascript-typescript-langserver)
+`npm i -g javascript-typescript-langserver`
+
+Then run the tests with `stack test` or `cabal new-test`.