diff --git a/README.md b/README.md index 209a1b7..0c1d1ff 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,24 @@ Using [packer](https://github.com/wbthomason/packer.nvim): use "Myzel394/easytables.nvim" ``` -### Setup +### Tutorial + +#### Inserting a new table + +Go to the place where you want to insert your table and either call: + +* `:EasyTablesCreateNew x` - Creates a new table with `` columns and `` rows +* `:EasyTablesCreateNew ` - Creates a square table with the size of `` (eg. `:EasyTablesCreateNew 5` -> Creates a `5x5` table) +* `:EasyTablesCreateNew x` - Creates a table with `` columns and **one** row +* `:EasyTablesCreateNew x` - Creates a table with **one** column and `` rows + +#### Editing an existing table + +Go to your table (doesn't matter where, can be at a border or inside a cell) and type: + +`:EasyTablesImportThisTable` + +### Custom Setup **Make sure to call the `setup` function!** @@ -215,6 +232,10 @@ This is the default configuration: } ``` +## Limitations + +* This plugin currently does not work well with big tables + ## This project is stupid, the code is awful, go away I know that the code is probably not the best, it's my first ever written neovim plugin.