initial

README.md

@@ -0,0 +1,63 @@
+# django.nvim
+
+Collection of commands for Django development.
+
+---
+
+## Requirements
+
+- [Neovim (v0.9.0 or latest)](https://github.com/neovim/neovim)
+
+### Required dependencies
+
+- [nvim-lua/plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
+- [akinsho/toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim)
+- [MunifTanjim/nui.nvim](https://github.com/MunifTanjim/nui.nvim)
+
+---
+
+## Installation
+
+Using [lazy.nvim](https://github.com/folke/lazy.nvim)
+
+```lua
+return {
+    {
+        'https://git.lucasf.dev/public/django.nvim',
+        config = function()
+        local django = require("django").setup()
+        end
+    }
+}
+```
+
+Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
+
+```lua
+use {'https://git.lucasf.dev/public/django.nvim'}
+```
+
+Using [vim-plug.nvim](https://github.com/junegunn/vim-plug)
+
+```lua
+Plug 'https://git.lucasf.dev/public/django.nvim'
+```
+
+---
+
+## Usage
+
+### Default Mappings
+
+| Mappings     | Action                                |
+| ------------ | ------------------------------------- |
+| `<leader>ja` | Create django app                     |
+| `<leader>jc` | Perform manage.py check               |
+| `<leader>je` | Create `.env` file                    |
+| `<leader>jh` | Perform manage.py showmigrations      |
+| `<leader>ji` | Perform manage.py migrate             |
+| `<leader>jm` | Perform manage.py makemigrations      |
+| `<leader>jp` | Create python package                 |
+| `<leader>jr` | Perform manage.py runserver           |
+| `<leader>jr` | Perform manage.py shell or shell_plus |
+| `<leader>jy` | Run celery                            |