Merge branch 'main' into feature/7

.github/workflows/bench.yml

@@ -0,0 +1,34 @@
+name: benchmark
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  # deployments permission to deploy GitHub pages website
+  deployments: write
+  # contents permission to update benchmark contents in gh-pages branch
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/dojoengine/dojo-dev:136a67a
+    steps:
+      - uses: actions/checkout@v3
+      - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+      - run: cargo bench --bench codec -- --output-format bencher |sed 1d | tee output.txt
+      - uses: benchmark-action/github-action-benchmark@v1
+        with:
+          tool: "cargo"
+          output-file-path: output.txt
+          benchmark-data-dir-path: "."
+          # Access token to deploy GitHub Pages branch
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          # Push and deploy GitHub pages branch automatically
+          auto-push: true
+          alert-threshold: "130%"
+          comment-on-alert: true
+          alert-comment-cc-users: "@kariy,@glihm,@tarrencev"

.gitignore

@@ -12,3 +12,5 @@ data
 
 crates/benches/gas_usage.txt
 crates/benches/bench_results.txt
+output.txt
+

README.md

@@ -10,19 +10,13 @@ Dojo provides a developer friendly framework for developing and scaling onchain
 
 ## 🚀 Quick Start
 
-See the [installation guide](https://book.dojoengine.org/getting-started/quick-start.html) in the Dojo book.
+See the [installation guide](https://book.dojoengine.org/getting-started/quick-start) in the Dojo book.
 
 ## ⛩️ Built with Dojo
 
 - [Awesome Dojo](https://github.com/dojoengine/awesome-dojo)
 - [Origami](https://github.com/dojoengine/origami)
 
-## 📚 Examples in 30s
-
-- [Dojo starter react](https://github.com/dojoengine/dojo-starter-react-app)
-- [Dojo starter phaser](https://github.com/dojoengine/dojo-starter-phaser)
-- [Dojo starter unity](https://github.com/dojoengine/dojo-starter-unity)
-
 ## 🗒️ Documentation
 
 You can find more detailed documentation in the Dojo Book [here](https://book.dojoengine.org/).
@@ -35,9 +29,9 @@ If you encounter issues or have questions, you can [submit an issue on GitHub](h
 
 We welcome contributions of all kinds from anyone. See our [Contribution Guide](/CONTRIBUTING.md) for more information on how to get involved.
 
-## ✏️ Enviroment
+## ✏️ Environment
 
-See our [Enviroment setup](https://book.dojoengine.org/getting-started/setup.html) for more information.
+See our [Environment setup](https://book.dojoengine.org/getting-started) for more information.
 
 ## Releasing