Add getCompletions helper function

[lsp-test.git] / README.md

diff --git a/README.md b/README.md
index b42dfcf81a7b6f4b4138e98028990b2e2a7ad3a2..0af386e54c3a75c8be2f2af3af767ff6fb2693ce 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
-# haskell-lsp-test
+# haskell-lsp-test [![Build Status](https://travis-ci.com/Bubba/haskell-lsp-test.svg?branch=master)](https://travis-ci.com/Bubba/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.
+
+```haskell
+runSession "session/root/dir" $ do
+  doc <- openDoc "foo.hs" "haskell"
+  
+  skipMany notification
+  
+  sendRequest TextDocumentDocumentSymbol (DocumentSymbolParams doc)
+              
+  rspSymbols <- response :: DocumentSymbolsResponse
+  let (List symbols) = fromJust (rspSymbols ^. result)
+```