Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joshstevens19 committed Jul 30, 2024
1 parent 4c4089a commit 3c76545
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
14 changes: 14 additions & 0 deletions documentation/docs/pages/docs/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@

all release branches are deployed through `release/VERSION_NUMBER` branches

## 0.4.0-beta - 30th July 2024

github branch - https://github.com/joshstevens19/rindexer/tree/release/0.4.0

- linux binary - https://rindexer.xyz/releases/linux-amd64/0.4.0/rindexer_linux-amd64.tar.gz
- mac apple silicon binary - https://rindexer.xyz/releases/darwin-arm64/0.4.0/rindexer_darwin-arm64.tar.gz
- mac apple intel binary - https://rindexer.xyz/releases/darwin-amd64/0.4.0/rindexer_darwin-amd64.tar.gz
- windows binary - https://rindexer/releases.xyz/win32-amd64/0.4.0/rindexer_win32-amd64.zip

### Features
-------------------------------------------------

- feat: create a docker image and github workflow for building it when pushed

## 0.3.1-beta - 30th July 2024

github branch - https://github.com/joshstevens19/rindexer/tree/release/0.3.1
Expand Down
10 changes: 6 additions & 4 deletions documentation/docs/pages/docs/introduction/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

rindexer installation process is simple and can be done with a few steps.

:::info
rindexer uses docker to spin up postgres databases for you when it runs locally so its recommended to install [docker](https://www.docker.com/products/docker-desktop/)
if you don't have it installed already.
:::

## rindexer CLI

rindexer operates as a CLI toolset to make it easy to create new rindexer projects or run existing ones.
Expand Down Expand Up @@ -60,10 +65,7 @@ To uninstall rindexer you can run the following command:
rindexerdown
```

## Docker

rindexer uses docker to spin up postgres databases for you when it runs locally so its recommended to install [docker](https://www.docker.com/products/docker-desktop/)
if you don't have it installed already.
## Docker pre-built image

There's a pre-built docker image which can be used to run `rindexer` inside your dockerized infra:

Expand Down

0 comments on commit 3c76545

Please sign in to comment.