Skip to content

Commit

Permalink
chore(docs): update readme (#2048)
Browse files Browse the repository at this point in the history
update readme and fix a spelling error

issue: none
  • Loading branch information
ttarsi authored Oct 2, 2024
1 parent 8827819 commit be109e7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,14 @@ Follow these steps to set up a functional development environment:
1. Install Docker Desktop.
2. Run `make install-go-tools`.
3. Run `make install-pre-commit`.
4. Run `pre-commit install --install-hooks` in the repo root directory.
5. Create a PGP key pair and [add the public key to Github](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account).
6. Configure Git:
```
4. Create a PGP key pair and [add the public key to Github](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account).
5. Configure Git. Please note that signing commits is required to merge a PR, and length 7 commit abbreviation is required to run `make build-docker` locally.

```bash
git config --local user.name <Foo Bar>
git config --local user.email <email@host.com>
git config --local core.abbrev 7
git config --local commit.gpgsign true
git config --local core.abbrev 7 # align short commits
git config --local commit.gpgsign true # sign commits
```

## Security
Expand Down
4 changes: 2 additions & 2 deletions docs/content/build/1-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ echo $CONTROLLER # XStakeController contract address on Omni EVM

### 5. Try it out

Setup env.
Setup environment.
```bash
source deployments.sh

Expand All @@ -143,7 +143,7 @@ cast send $OP_TOKEN "approve(address,uint256)" $OP_XSTAKER 100 --rpc-url $OP_R

Calculate xcall fee.
```bash
cast call $OP_XSTAKER "stakeFee(uint256)(uint256)" 100 --rpc-url $OP_RCP
cast call $OP_XSTAKER "stakeFee(uint256)(uint256)" 100 --rpc-url $OP_RPC
```


Expand Down

0 comments on commit be109e7

Please sign in to comment.