init

.github/workflows/ci.yml

@@ -14,7 +14,6 @@ jobs:
           version: latest
           args: --check .
 
-
   docs:
     runs-on: ubuntu-latest
     name: pandoc to vimdoc
@@ -24,11 +23,11 @@ jobs:
       - name: panvimdoc
         uses: kdheepak/panvimdoc@main
         with:
-          vimdoc: nvim-plugin-template
+          vimdoc: drash
           treesitter: true
       - uses: stefanzweifel/git-auto-commit-action@v4
         with:
-          commit_message: 'chore(doc): auto generate docs'
+          commit_message: "chore(doc): auto generate docs"
           commit_user_name: "github-actions[bot]"
           commit_user_email: "github-actions[bot]@users.noreply.github.com"
           commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"

README.md

@@ -1,38 +1,23 @@
-# nvim-plugin-template
+# drash.nvim
 
-Neovim plugin template; includes automatic documentation generation from README, integration tests with Busted, and linting with Stylua
+A Neovim plugin for helping to write a Drash/D'var Torah in without leaving Neovim. It relies on the Sefaria API to provide info on the Parsha and any supporting texts you might need.
 
-## Usage
+## Development
 
-1. Click `use this template` button generate a repo on your github.
-2. Clone your plugin repo. Open terminal then cd plugin directory.
-3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`. 
-   Then it will prompt you input `y` or `n` to remove example codes in `init.lua` and
-   `test/plugin_spec.lua`. If you are familiar this repo just input `y`. If you are looking at this template for the first time I suggest you inspect the contents. After this step `rename.py` will also auto-remove.
-
-Now you have a clean plugin environment. Enjoy!
-
-## Format
+### Format
 
 The CI uses `stylua` to format the code; customize the formatting by editing `.stylua.toml`.
 
-## Test
+### Test
 
 Uses [busted](https://lunarmodules.github.io/busted/) for testing. Installs by using `luarocks --lua-version=5.1 install vusted` then runs `vusted ./test`
 for your test cases. `vusted` is a wrapper of Busted especially for testing Neovim plugins.
 
 Create test cases in the `test` folder. Busted expects files in this directory to be named `foo_spec.lua`, with `_spec` as a suffix before the `.lua` file extension. For more usage details please check
 [busted usage](https://lunarmodules.github.io/busted/)
 
-## CI
+### CI
 
 - Auto generates doc from README.
 - Runs the Busted/vusted integration tests
 - Lints with `stylua`.
-
-
-## More
-
-To see this template in action, take a look at my other plugins.
-
-## License MIT

test/plugin_spec.lua

@@ -1,8 +1 @@
-local example = require('nvim-plugin-template').example
 
-describe('neovim plugin', function()
-  it('work as expect', function()
-    local result = example()
-    assert.is_true(result)
-  end)
-end)