Skip to content

Commit e8665bb

Browse files
committed
chore: update documentation
1 parent 40ada75 commit e8665bb

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# nbcat
1+
<h1 align="center">nbcat: Jupyter notebooks viewer</h1>
22

3-
`nbcat` let you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.
3+
[nbcat](https://github.com/akopdev/nbcat) let you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.
44

55
<p align="center">
66
<a href="docs/screenshot.png" target="blank"><img src="docs/screenshot.png" width="400" /></a>
@@ -28,12 +28,12 @@ Please note, that `nbcat` doesn't aim to replace JupyterLab. If you need a full-
2828
## Installation
2929

3030
```bash
31-
# Install from PyPI
32-
pip install nbcat
31+
# Install from PyPI (recommended)
32+
$ pip install nbcat
3333

3434
# Install via Homebrew
35-
brew tab akopdev/formulas/nbcat
36-
brew install nbcat
35+
$ brew tab akopdev/formulas/nbcat
36+
$ brew install nbcat
3737
```
3838

3939
## Quickstart
@@ -47,7 +47,7 @@ You can pass URLs as well.
4747
```bash
4848
$ nbcat https://raw.githubusercontent.com/akopdev/nbcat/refs/heads/main/tests/assets/test4.ipynb
4949
```
50-
In most cases system `less` will break images rendering. You can use an internal pager instead:
50+
In most cases system `less` will render images in low resolution. Consider using an internal pager instead:
5151

5252
```bash
5353
$ nbcat notebook.ipynb --page

0 commit comments

Comments
 (0)