(docs): point out the main feature and update description.

This commit is contained in:
Eduard Tolosa 2025-05-03 23:34:16 -05:00
parent b8b2c6f0f8
commit 0b117ac07c

View file

@ -1,5 +1,5 @@
# Description # Description
Simple and handy btrfs snapshoting tool. Supports unattended snapshots, tracking, restoring, automatic cleanup and more. Backed with SQLite. Simple and handy definitions-based snapshoting tool for BTRFS. Supports unattended snapshots, tracking, restoring, automatic cleanup and more. Backed with SQLite.
# Documentation # Documentation
@ -7,6 +7,10 @@ See the [docs folder](https://github.com/Edu4rdSHL/rusnapshot/blob/master/docs/)
# Features # Features
**The main feature of Rustnapshot is the ability to create snapshots of BTRFS subvolumes using simple TOML definitions. It is designed to be simple and easy to use, while still providing powerful features for managing snapshots. See [the examples folder](https://github.com/Edu4rdSHL/rusnapshot/tree/master/examples) for more information.**
Among the features of Rustnapshot are:
- Allows you to specify the origin and destination of snapshots at will of the user. - Allows you to specify the origin and destination of snapshots at will of the user.
- Track snapshots using SQLite as backend database. - Track snapshots using SQLite as backend database.
- Easy setup using small templates instead of confusing long files. - Easy setup using small templates instead of confusing long files.