chore(docs): first iteration

moniquelive · Jan 19, 2025 · ce902fb · ce902fb
1 parent f9cd215
commit ce902fb
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 44 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 MoniqueLive
+Copyright (c) 2025 MoniqueLive
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/doc/rfc.nvim.txt b/doc/rfc.nvim.txt
@@ -1,66 +1,44 @@
-*nvim-plugin-template.txt*     For NVIM v0.8.0     Last change: 2024 August 27
+*rfc.nvim*     Telescope plugin for browsing (and reading) RFCs
+*rfc.nvim*
 
-==============================================================================
-Table of Contents                     *nvim-plugin-template-table-of-contents*
+Author:  Monique Oliveira <https://github.com/moniquelive>
+License: MIT License
 
-1. nvim-plugin-template            |nvim-plugin-template-nvim-plugin-template|
-  - Usage                    |nvim-plugin-template-nvim-plugin-template-usage|
-  - Format                  |nvim-plugin-template-nvim-plugin-template-format|
-  - Test                      |nvim-plugin-template-nvim-plugin-template-test|
-  - CI                          |nvim-plugin-template-nvim-plugin-template-ci|
-  - More                      |nvim-plugin-template-nvim-plugin-template-more|
-  - License MIT        |nvim-plugin-template-nvim-plugin-template-license-mit|
+DESCRIPTION                            *rfc*
 
-==============================================================================
-1. nvim-plugin-template            *nvim-plugin-template-nvim-plugin-template*
+Telescope plugin for browsing (and reading) RFCs.
 
-Neovim plugin template; includes automatic documentation generation from
-README, integration tests with Busted, and linting with Stylua
 
+USAGE                                  *rfc-usage*
 
-USAGE                        *nvim-plugin-template-nvim-plugin-template-usage*
+By calling Telescope:<
+  Telescope rfc
+>
 
-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.
+Or from Lua:<lua
+  require('telescope').extensions.rfc.rfc()
+>
 
-Now you have a clean plugin environment. Enjoy!
 
+TEST                                   *rfc-test*
 
-FORMAT                      *nvim-plugin-template-nvim-plugin-template-format*
+Uses plenary version of busted <https://lunarmodules.github.io/busted/> for
+testing.
 
-The CI uses `stylua` to format the code; customize the formatting by editing
-`.stylua.toml`.
-
-
-TEST                          *nvim-plugin-template-nvim-plugin-template-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
+Create test cases in the `lua/tests/rfc` 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                              *nvim-plugin-template-nvim-plugin-template-ci*
+CI                                     *rfc-ci*
 
 - Auto generates doc from README.
 - Runs the Busted/vusted integration tests
-- Lints with `stylua`.
-
-
-MORE                          *nvim-plugin-template-nvim-plugin-template-more*
 
-To see this template in action, take a look at my other plugins.
 
 
-LICENSE MIT            *nvim-plugin-template-nvim-plugin-template-license-mit*
+LICENSE MIT                            *rfc-license-mit*
 
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>