Skip to content

Commit

Permalink
localstorage: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Pondidum committed Apr 28, 2024
1 parent cf524ad commit e019847
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions localstorage/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Localstorage

This represents the working directory where `cas` is run. its purpose is to read artifacts from disk, and send to a backend, and also to write the files from the backend to disk.

## `.archive` files

If `ReadFile()` is called with `.archive`, the working directory of the file is compressed into a tar file, and then the resulting archive is returned.

If `WriteFile()` is called with `.archive`, the file is extracted into the directory instead of the `.archive` file being written to disk itself.

0 comments on commit e019847

Please sign in to comment.