Update README.md

This commit is contained in:
Myzel394 2023-10-08 19:49:45 +02:00 committed by GitHub
parent 6e59d9a262
commit 00e9415ae7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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 <width>x<height>` - Creates a new table with `<width>` columns and `<height>` rows
* `:EasyTablesCreateNew <width>` - Creates a square table with the size of `<width>` (eg. `:EasyTablesCreateNew 5` -> Creates a `5x5` table)
* `:EasyTablesCreateNew <width>x` - Creates a table with `<width>` columns and **one** row
* `:EasyTablesCreateNew x<height>` - Creates a table with **one** column and `<height>` 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 very bid 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.