improve readme

README.md

@@ -1,6 +1,38 @@
 # Comment-REPL.nvim
 
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/atinylittleshell/comment-repl.nvim/lint-test.yml?branch=main&style=for-the-badge)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/atinylittleshell/comment-repl.nvim/lint_test.yml?branch=main&style=for-the-badge)
 ![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)
 
-A Neovim plugin for executing REPLs directly in your buffers and showing results as comments.
+Execute code directly from your buffer and print the output as a comment.
+
+## How does it work
+
+[Screenshot](doc/screenshot.png)
+
+## Installation
+
+Using lazy.nvim:
+
+```lua
+{
+  'atinylittleshell/comment-repl.nvim',
+  opts = {},
+}
+```
+
+## Configuration
+
+See [config.lua](lua/comment-repl/config.lua) for config schema and default values.
+
+## Commands
+
+`:CommentREPLExecute` - Execute the code cell at the cursor and print the output as a comment.
+
+`:CommentREPLLog` - View logs from Comment-REPL.nvim.
+
+```lua
+-- By default the plugin will not enable any key bindings.
+-- Your can define your own keybind behavior like below.
+vim.keymap.set('n', '<leader>ce', '<cmd>CommentREPLExecute<CR>')
+vim.keymap.set('n', '<leader>cl', '<cmd>CommentREPLLog<CR>')
+```

examples/python.py

@@ -1,16 +1,23 @@
-i = 30
-print(i)
+def fibonacci_below(n):
+    a, b = 0, 1
+    while a < n:
+        print(a, end=" ")
+        a, b = b, a + b
+
+
+fibonacci_below(5)
 
 
 """
-30
+0 1 1 2 3 
 """
 
 # %%
-j = {"hello", "world"}
-print(j)
+# The marker above separates the code below into a different cell
+
+fibonacci_below(10)
 
 
 """
-{'world', 'hello'}
+0 1 1 2 3 5 8 
 """

lua/comment_repl/config.lua

@@ -14,6 +14,7 @@
 ---@field repls table<string, LanguageConfig>?
 local M = {
   output = {
+    -- Margin around the output comment
     margin = {
       top = 2,
       bottom = 1,
@@ -23,14 +24,18 @@ local M = {
     level = "info",
   },
   repls = {
+    -- Python is supported by default
     python = {
       display = "Python",
       cmd = "python",
       args = { "-i" },
+      -- The marker is what separates code cells
       cell_marker = "# %%",
       multi_line_comment_open = '"""',
       multi_line_comment_close = '"""',
     },
+    -- Add your own repl configurations below.
+    -- Use filetype as the key.
   },
 }