Skip to content

Commit

Permalink
fix: README format
Browse files Browse the repository at this point in the history
  • Loading branch information
Justintime50 committed Nov 23, 2024
1 parent ce0c1d5 commit db6f9f9
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,24 @@ Update, backup, and administer your Homebrew or Chocolatey instance.

> Bubble bubble, toil and brew...
## Install

### macOS and Linux

```bash
# Setup the tap
brew tap justintime50/formulas

# Install the tool
brew install alchemist
```

### Windows

Download the Windows binary from the [releases page](https://github.com/Justintime50/alchemist/releases).

## Usage

## Alchemist Backup

Alchemist can backup your entire Homebrew (macOS and Linux) or Chocolatey (Windows) instance. It does this by retrieving the list of installed packages and creating a script that can be run to restore your entire Homebrew or Chocolatey instance.
Expand All @@ -32,8 +50,8 @@ If you run into troubles backing up your Homebrew instance, it's recommended to
Alchemist automates the entire Homebrew update process including:

1. Updating available taps and formula references
1. Upgrading packages
1. Upgrading casks
1. Upgrading formula
1. Upgrading casks (macOS)
1. Cleaning up old/stale taps and formula
1. Checking for problems with your Homebrew instance

Expand All @@ -45,24 +63,6 @@ Alchemist will update all of your Chocolatey packages:
alchemist --update
```

## Install

### macOS and Linux

```bash
# Setup the tap
brew tap justintime50/formulas

# Install the tool
brew install alchemist
```

### Windows

Download the Windows binary from the [releases page](https://github.com/Justintime50/alchemist/releases).

## Usage

### Logs

Alchemist saves logs to `~/alchemist/update/alchemist-update.log`. Logs by default are kept on the system for `90 days` and are automatically rotated for you once their size exceeds 1mb or the logs become older than 90 days.
Expand Down

0 comments on commit db6f9f9

Please sign in to comment.