📚 docs(atuin): added README file

This commit is contained in:
Sergio Laín 2023-10-27 00:41:25 +02:00
parent 59855d3a75
commit e34fd21510
No known key found for this signature in database
GPG key ID: 14C9B8080681777B
6 changed files with 28 additions and 1 deletions

28
.config/atuin/README.md Normal file
View file

@ -0,0 +1,28 @@
<div align="center">
<a href=""><img src="../../.github/assets/images/atuin-title.png"></a>
</div>
<p align="center">
<a href="#about"><img width="195px" src="../../.github/assets/images/dotfiles-about.png"></a>
<a href="#config"><img width="195px" src="../../.github/assets/images/dotfiles-config.png"></a>
<a href="#gallery"><img width="195px" src="../../.github/assets/images/dotfiles-gallery.png"></a>
</p>
## :arrows_counterclockwise: <samp>[Shell History Sync](#arrows_counterclockwise-about)</samp>
Atuin is such a cool tool. It lets you easily sync all your shell history across multiple devices. I was looking for something like this for a while, and I'm glad I found it.
## :gear: <samp>[Configuration](#gear-config)</samp>
I have set Atuin to function with my shell (fish), so if you have a different shell, go over to the Fish Configuration section of the dotfiles to see how to change it.
That's only part of initializing Atuin to be able to work with your shell.
Apart from that, the configuration file can be used with all the common shells like zsh, bash, etc.
For more info on how to configure the Atuin config file, check out the **official [Atuin Configuration Guide](https://atuin.sh/docs/config/)**.
## :camera: <samp>[Gallery](#camera-gallery)</samp>
![overview-1](../../.github/assets/images/screenshots/atuin-overview-1.png)
![overview-2](../../.github/assets/images/screenshots/atuin-overview-2.png)

View file

@ -91,5 +91,4 @@ inline_height = 40
# "^/very/secret/area" # "^/very/secret/area"
# ] # ]
invert = true
enter_accept = true enter_accept = true

BIN
.github/assets/images/atuin-title.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 603 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 720 KiB