Update readme for 0.6

This commit is contained in:
Josh Hansen 2023-10-02 00:31:22 -07:00
parent 5d6f307fb4
commit dddbd0571d
2 changed files with 27 additions and 3 deletions

View file

@ -28,7 +28,7 @@ Running `ghee` with no arguments will enter a read-eval-print-loop (REPL), allow
```
$ ghee
Ghee 0.5.1
Ghee 0.6.0
ghee$ set ./test -s test=1
```
@ -184,8 +184,20 @@ Each path is marked as either a table or a record. For tables, the primary key i
### Commit
Stores the current state of the table in a Btrfs snapshot, identified by a UUID.
Optionally, a message describing the changes made since the last snapshot (if any) can be provided.
* `ghee commit -m "Update README.md"`
The UUID of the commit is outputted.
### Log
Displays past commits.
* `ghee log`: Lists all past commits in the current table
### Touch
Similar to the Unix `touch` command, creates an empty file at the specified path;
@ -197,4 +209,16 @@ This is a convenient way to add new records to new tables.
With `-p / --parents`, parent directories will be created.
* `ghee touch /pizza/pepperoni`: creates an empty file at `/pizza/pepperoni`, setting
xattr `topping` to `pepperoni` because the key of the `/pizza` table is `topping`.
xattr `topping` to `pepperoni` because the key of the `/pizza` table is `topping`.
### Restore
Restores paths to their state in the `HEAD` commit.
* `ghee restore README.md`
### Reset
Resets all files in the table to their state in a specified commit.
* `ghee reset add133b4-f58b-a64e-992a-46f983a0e7ed`

View file

@ -16,7 +16,7 @@
-[x] Cover absolute paths in example.sh
-[x] Version user.ghee namespace
-[x] Rename most-recent-snapshot -> HEAD
-[ ] Update README.md for 0.6
-[x] Update README.md for 0.6
## 0.7
-[ ] `ghee branch`: branch management