From e8ce1d3047b076b4d2396f3f26579cf53475effa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=B3n=C3=A1n=20Carrigan?= <rcarriga@tcd.ie>
Date: Mon, 13 Jun 2022 08:44:59 +0100
Subject: [PATCH] docs: README

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4fb6a89
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# neotest-python
+
+[Neotest](https://github.com/rcarriga/neotest) adapter for python.
+Supports Pytest and unittest test files.
+
+Requires [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) and the parser for python.
+
+```lua
+require("neotest").setup({
+  adapters = {
+    require("neotest-python")
+  }
+})
+```
+
+You can optionally supply configuration settings:
+```lua
+require("neotest").setup({
+  adapters = {
+    require("neotest-python")({
+        -- Extra arguments for nvim-dap configuration
+        dap = { justMyCode = false },
+        -- Command line arguments for runner
+        -- Can also be a function to return dynamic values
+        args = {"--log-level", "DEBUG"},
+        -- Runner to use. Will use pytest if available by default.
+        -- Can be a function to return dynamic value.
+        runner = "pytest",
+        
+    })
+  }
+})
+
+```