Skip to content

Commit

Permalink
docs: add warning about keeping indexer version aligned with project …
Browse files Browse the repository at this point in the history
…version (#1494)

Co-authored-by: alvarius <[email protected]>
  • Loading branch information
qbzzt and alvrs authored Sep 14, 2023
1 parent c3212a3 commit 5150544
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/pages/indexer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ They are written under the assumption you are using `anvil` for your test chain,
1. Run a test world.
The easiest way to do this is to follow [these directions](tutorials/minimal#getting-the-initial-version) in a separate command line window.

**Note**: While MUD v2 is in alpha, there might be breaking changes between pre-release versions.
To ensure your World is compatible with your indexer, make sure both are running the same MUD version.
To create a project with the MUD version on the `main` branch, use `mud@main` instead of ~`mud@next`~.

```sh copy
pnpm create mud@main project-name
```

1. Start the indexer.

```sh copy
Expand Down

0 comments on commit 5150544

Please sign in to comment.