Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into feature/pchakrab/prin…
Browse files Browse the repository at this point in the history
…t-version-info
  • Loading branch information
pchakraborty committed Aug 12, 2024
2 parents 0b71055 + 1b379a0 commit 820c496
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

## [2.0.0] - 2024-08-09
## [2.0.0] - 2024-08-12

### Fixed

Expand Down
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,42 @@

## Installation

### Using pip

To install `mepo` using `pip`, run the following command:

```
`pip install mepo`
```

### Homebrew

Using Homebrew, you can install `mepo` by installing from the gmao-si-team tap:

```
brew install gmao-si-team/packages/mepo
```

This is equivalent to running:

```
brew tap gmao-si-team/packages
brew install mepo
```

## Transitioning from `mepo` v1.x to v2.x

If you try to use mepo v2.x within a mepo v1.x repository, you will get an warning message:
```
Detected mepo1 style state
Run <mepo update-state> to permanently convert to mepo2 style
```

To update your repository to work with mepo v2.x, you can run the following command:
```
mepo update-state
```
and it will convert the repository from mepo v1 pickle-state to mepo v2 json-state.

## Commands

Expand Down

0 comments on commit 820c496

Please sign in to comment.