Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cnpryer committed May 4, 2024
1 parent b8699a1 commit 8612f0b
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

[![pypi-release](https://img.shields.io/pypi/v/huak.svg)](https://pypi.org/project/huak/)
<!-- [![pypi-release](https://img.shields.io/pypi/v/huak.svg)](https://pypi.org/project/huak/) -->
[![ci](https://github.com/cnpryer/huak/actions/workflows/ci.yaml/badge.svg)](https://github.com/cnpryer/huak/actions/workflows/ci.yaml)

# huak
Expand All @@ -26,22 +26,20 @@ The goal is to create an opinionated tool to support a reliably inviting onboard

- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)
- [Goals and Motivation](#goals)
- [Contributing](#contributing)

## Installation

```
pip install huak
```

To install Huak from source using Cargo:

```
cargo install --git https://github.com/cnpryer/huak.git huak
```

> ⚠️ WARNING: The PyPI distribution is outdated.
## Usage

```console
Expand Down Expand Up @@ -78,11 +76,6 @@ Options:
-V, --version Print version
```

## Documentation

- [User Guide](https://cnpryer.github.io/huak/user_guide/)
- [Development](/docs/development.md)

## Goals

### 1. Just use `huak`
Expand Down

0 comments on commit 8612f0b

Please sign in to comment.