📚 docs(atuin): include new changes to the README

This commit is contained in:
Sergio Laín 2023-12-23 18:50:44 +01:00
parent e8aa1f89cb
commit 4685762bce
No known key found for this signature in database
GPG key ID: 14C9B8080681777B

View file

@ -2,19 +2,27 @@
<a href=""><img src="./title.png"></a> <a href=""><img src="./title.png"></a>
</div> </div>
<p align="center"> <div 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> <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png" width="65%"/><br>
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. </div>
<div align="center">
<a href="#herb--about"><img width="190px" src="../../../.github/assets/category-images/dotfiles-about.png"></a>
<a href="#gear--config"><img width="190px" src="../../../.github/assets/category-images/dotfiles-config.png"></a>
<a href="#camera--gallery"><img width="190px" src="../../../.github/assets/category-images/dotfiles-gallery.png"></a>
</div>
# :herb: <samp>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.
After the installation, you have to create a user with a password and save the key that will be given to you. Then you use that key and user on the other PC to sync their history together. After the installation, you have to create a user with a password and save the key that will be given to you. Then you use that key and user on the other PC to sync their history together.
## :gear: <samp>[Configuration](#gear-config)</samp> # :gear: <samp>Config</samp>
Atuin works at the start of a session with the shell you have. Atuin works at the start of a session with the shell you have.
@ -25,7 +33,7 @@ I have Atuin configured to work with the fish shell, as it is the one I use on a
Aside from that, I have configured Atuin to replace the up-arrow history of Fish with a fuzzy search included in Atuin itself. Aside from that, I have configured Atuin to replace the up-arrow history of Fish with a fuzzy search included in Atuin itself.
I also changed the frequency at which Atuin syncs its history with the server; it basically syncs every time you execute a command (**dont worry**, it will not slow down your shell). I also changed the frequency at which Atuin syncs its history with the server; it basically syncs every time you execute a command (**dont worry**, it will not slow down your shell).
## :camera: <samp>[Gallery](#camera-gallery)</samp> # :camera: <samp>Gallery</samp>
![overview-1](./overview-1.png) ![overview-1](./overview-1.png)