Skip to content

Commit

Permalink
Update readme with better install options
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Emann committed Apr 10, 2024
1 parent e99dfd4 commit f1d54cc
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,24 @@ algorithms used by HFS+/APFS: LZFSE, LZVN, and ZLIB.

## Installation

### Building with Cargo
### Install via Homebrew

To install Applesauce using Homebrew, run the following command:

```console
brew install Dr-Emann/homebrew-tap/applesauce
```

### Install prebuilt binaries via shell script

```console
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/Dr-Emann/applesauce/releases/latest/download/applesauce-cli-installer.sh | sh
```

### Manual build with Cargo

<details>
<summary>Details</summary>

To install Applesauce using Cargo, follow these steps:

Expand All @@ -19,9 +36,7 @@ To install Applesauce using Cargo, follow these steps:
3. In the project directory, run `cargo build --release` to build the program.
4. The built binary can be found in the `target/release` directory.

### Installing from GitHub Releases

Alternatively, you can download pre-built binaries from the [GitHub releases page](https://github.com/Dr-Emann/applesauce/releases).
</details>

## Usage

Expand All @@ -31,20 +46,19 @@ To use Applesauce, run the following command:
applesauce [compress|decompress|info] file/directory
```


The options are as follows:

- `compress`: Compresses the specified file/directory using one of three compression algorithms (LZFSE, LZVN, or ZLIB).
- `decompress`: Decompresses the specified file/directory.
- `info`: Prints information about the specified compressed file/directory, including the compression ratio and compression algorithm used.
- `info`: Prints information about the specified compressed file/directory, including the compression ratio and
compression algorithm used.

For example, to compress a file named `example.txt` using the ZLIB compression algorithm, you would run:

```console
applesauce compress -c ZLIB example.txt
```


## Features

Applesauce has the following key features:
Expand Down Expand Up @@ -97,7 +111,7 @@ user-friendly experience than afsctool's sparse output.

#### Better Compression With Many Small Files

afsctool will compress a file which fits in the xattr after compression, even
afsctool will compress a file which fits in the xattr after compression, even
if doing so actually adds more overhead than leaving the file uncompressed.
Applesauce will not compress a file if it would result in a larger file.

Expand Down

0 comments on commit f1d54cc

Please sign in to comment.