Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hat0uma committed Feb 2, 2025
1 parent f1db028 commit 3dd22d3
Showing 1 changed file with 25 additions and 22 deletions.
47 changes: 25 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
# csvview.nvim

`csvview.nvim` is a lightweight CSV file viewer plugin for Neovim.
With this plugin, you can easily view and edit CSV files within Neovim.
<h1 align="center">csvview.nvim</h1>
<p align="center">A comfortable CSV/TSV editing plugin for Neovim</p>

![csvview](https://github.com/hat0uma/csvview.nvim/assets/55551571/27130f41-98f5-445d-a9eb-643b31e0b96b)

## Features
## ✨ Features

- Displays the CSV/TSV file in a tabular format using virtual text.
- Dynamically updates the CSV view as you edit, ensuring a seamless editing experience.
- Asynchronous parsing enables comfortable handling of large CSV files.
- Can ignore comment lines when displaying the CSV file.
- Supports two display modes:
- `highlight`: Highlights the delimiter.
- `border`: Displays the delimiter with `β”‚`.
- Customizable delimiter character and comment prefix.
- **Tabular Display**: Displays CSV/TSV files in a virtual text table.
- **Dynamic Updates**: Automatically refreshes the table as you edit.
- **Asynchronous Parsing**: Smoothly handles large CSV files without blocking.
- **Text Objects & Motions**: Conveniently select fields or move across fields/rows.
- **Comment Ignoring**: Skips specified comment lines from the table display.
- **Flexible Settings**: Customizable delimiter and comment prefix.
- **Two Display Modes**:
- `highlight`: Highlights delimiters.
- `border`: Uses a vertical border (`β”‚`) as delimiters.

<table>
<tr>
Expand All @@ -30,11 +29,11 @@ With this plugin, you can easily view and edit CSV files within Neovim.
</tr>
</table>

## Requirements
## ⚑ Requirements

Neovim v0.10 or newer is required.

## Installation
## πŸ“¦ Installation

Install the plugin using your favorite package manager.

Expand Down Expand Up @@ -72,7 +71,7 @@ Plug 'hat0uma/csvview.nvim'
lua require('csvview').setup()
```

## Configuration
## πŸ› οΈ Configuration

`csvview.nvim` are highly customizable, Please refer to the following default settings.

Expand Down Expand Up @@ -246,7 +245,7 @@ lua require('csvview').setup()

</details>

## Usage
## πŸš€ Usage

After opening a CSV file, use the following commands to interact with the plugin:

Expand Down Expand Up @@ -274,7 +273,7 @@ To toggle CSV view with a custom field delimiter, a custom string delimiter and

### Lua API

Below are the core Lua functions that you can call programmatically.
Below are the core Lua functions that you can call programmatically. If you want to map these functions to key bindings, you can use the `opts.keymaps` option.

#### Basic Functions

Expand Down Expand Up @@ -361,14 +360,14 @@ vim.api.nvim_create_autocmd("User", {
})
```

## Highlights
## 🌈 Highlights

| Group | Default | Description |
| -------------------- | ------------------ | ------------------- |
| **CsvViewDelimiter** | link to `Comment` | used for `,` |
| **CsvViewComment** | link to `Comment` | used for comment |

## TODO
## πŸ“ TODO

- [x] Customizable delimiter character.
- [x] Ignore comment lines.
Expand All @@ -381,6 +380,10 @@ vim.api.nvim_create_autocmd("User", {
- Pre- and post-processing of files, such as reading/writing Excel files.
- Displaying tables embedded in Markdown as formatted tables.

## License
## 🀝 Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

## πŸ“„ License

This plugin is released under the MIT License
Distributed under the MIT License.

0 comments on commit 3dd22d3

Please sign in to comment.