Skip to content

Commit

Permalink
Update docs and CHANGELOG for v0.8.1 (#107)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlange-42 authored Jan 23, 2025
1 parent 98e84b7 commit ab433b5
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,4 @@ jobs:
- name: Upload to PyPI
if: ${{ github.event_name == 'release' }}
run: |
python -m twine upload --verbose --skip-existing -u __token__ -p ${{ secrets.PYPI_TOKEN }} dist/*
python -m twine upload --verbose -u __token__ -p ${{ secrets.PYPI_TOKEN }} dist/*
6 changes: 2 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
## [[unpublished]](https://github.com/mlange-42/modo/compare/v0.8.0...main)
## [[v0.8.1]](https://github.com/mlange-42/modo/compare/v0.8.0...v0.8.1)

### Other

* Modo is now installable with `pip`, as `pymodo` (#102, #104)
Modo🧯 is now installable with `pip`, as `pymodo` (#102, #104)

## [[v0.8.0]](https://github.com/mlange-42/modo/compare/v0.7.0...v0.8.0)

Expand Down
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,30 @@ See the [User guide](https://mlange-42.github.io/modo/) for more information.

## Installation

Pre-compiled binaries for Linux, Windows and MacOS are available in the
[Releases](https://github.com/mlange-42/modo/releases).
### Using Python

> Alternatively, install using [Go](https://go.dev):
> ```shell
> go install github.com/mlange-42/modo@latest
> ```
Modo🧯 is available on PyPI as [`pymodo`](https://pypi.org/project/pymodo/).
Install it with pip:

```
pip install pymodo
```

> This installs the `modo` command. If the command is not found, try:
> `python -m pymodo`
### Using Go

With [Go](https://go.dev) installed, you can install Modo🧯 like this:
```shell
go install github.com/mlange-42/modo@latest
```

### Precompiled binaries

Pre-compiled binaries for manual installation are available in the
[Releases](https://github.com/mlange-42/modo/releases)
for Linux, Windows and MacOS.

## Usage

Expand Down
29 changes: 23 additions & 6 deletions docs/content/guide/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,30 @@ weight: 1

## Installation

Pre-compiled binaries for Linux, Windows and MacOS are available in the
[Releases](https://github.com/mlange-42/modo/releases).
### Using Python

> Alternatively, install using [Go](https://go.dev):
> ```shell {class="no-wrap"}
> go install github.com/mlange-42/modo@latest
> ```
Modo🧯 is available on PyPI as [`pymodo`](https://pypi.org/project/pymodo/).
Install it with pip:

```
pip install pymodo
```

> This installs the `modo` command. If the command is not found, try:
> `python -m pymodo`
### Using Go

With [Go](https://go.dev) installed, you can install Modo🧯 like this:
```shell
go install github.com/mlange-42/modo@latest
```

### Precompiled binaries

Pre-compiled binaries for manual installation are available in the
[Releases](https://github.com/mlange-42/modo/releases)
for Linux, Windows and MacOS.

## Usage

Expand Down

0 comments on commit ab433b5

Please sign in to comment.