Updated README.
This commit is contained in:
parent
312435bea2
commit
55fe665261
18
README.md
18
README.md
@ -17,6 +17,7 @@
|
||||
[What and Why](#whatandwhy) •
|
||||
[Philosophy](#philosophy) •
|
||||
[Installation](#Installation) •
|
||||
[Usage](#Usage) •
|
||||
[Examples](#examples) •
|
||||
[Just Use the Patterns](#just-use-the-patterns) •
|
||||
[Custom Patterns](#custom-patterns) •
|
||||
@ -33,6 +34,7 @@
|
||||
- [Too many prompts](#too-many-prompts)
|
||||
- [The Fabric approach to prompting](#our-approach-to-prompting)
|
||||
- [Installation](#Installation)
|
||||
- [Usage](#Usage)
|
||||
- [Examples](#examples)
|
||||
- [Just use the Patterns](#just-use-the-patterns)
|
||||
- [Custom Patterns](#custom-patterns)
|
||||
@ -92,11 +94,15 @@ Fabric has Patterns for all sorts of life and work activities, including:
|
||||
## Installation
|
||||
|
||||
To install Fabric, make sure Go is installed, and then run the following command.
|
||||
```
|
||||
go install github.com/danielmiessler/fabric@latest` in the main directory!
|
||||
|
||||
```bash
|
||||
# Install Fabric directly from the repo
|
||||
go install github.com/danielmiessler/fabric@latest
|
||||
# Run the setup to set up your directories and keys
|
||||
fabric --setup
|
||||
```
|
||||
|
||||
## Usage
|
||||
Once you have it all set up, here's how to use it.
|
||||
|
||||
1. Check out the options
|
||||
@ -164,14 +170,14 @@ Help Options:
|
||||
If you have the Legacy (Python) version installed and want to migrate to the Go version, here's how you do it. It's basically two steps: 1) uninstall the Python version, and 2) install the Go version.
|
||||
|
||||
```bash
|
||||
// Uninstall Legacy Fabric
|
||||
# Uninstall Legacy Fabric
|
||||
pipx uninstall fabric
|
||||
|
||||
// Clear any old Fabric aliases
|
||||
# Clear any old Fabric aliases
|
||||
(check your .bashrc, .zshrc, etc.)
|
||||
// Install the Go version
|
||||
# Install the Go version
|
||||
go install github.com/danielmiessler/fabric@latest
|
||||
// Run setup for the new version. Important because things have changed
|
||||
# Run setup for the new version. Important because things have changed
|
||||
fabric --setup
|
||||
```
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user