[Graphite MQ] Draft PR GROUP:f1a327 (PRs 554, 555)

README.md

@@ -1,79 +1,70 @@
-# Rivet CLI
+# ⛓️ Rivet Toolchain
 
 ## Installation
 
 <details>
-<summary><b>macOS & Linux & WSL</b></summary>
-
-**Install latest version**
+<summary><b>Windows (x86)</b></summary>
 
 ```sh
-curl -fsSL https://raw.githubusercontent.com/rivet-gg/cli/main/install/unix.sh | sh
+curl -L https://releases.rivet.gg/toolchain/v2.0.0-rc.5/windows_x86_64/rivet.exe.zip -o rivet.exe.zip
+unzip rivet.exe.zip
 ```
 
-**Install specific version**
+Add the directory containing rivet.exe to your PATH environment variable.
+</details>
 
-We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI.
+<details>
+<summary><b>macOS (Apple Silicon)</b></summary>
 
 ```sh
-export RIVET_CLI_VERSION="v1.0.0"
-curl -fsSL https://raw.githubusercontent.com/rivet-gg/cli/${RIVET_CLI_VERSION}/install/unix.sh | sh
+curl -L https://releases.rivet.gg/toolchain/v2.0.0-rc.5/macos_arm64/rivet.zip -o rivet.zip
+unzip rivet.zip
+chmod +x rivet
+sudo mv rivet /usr/local/bin/
 ```
-
-_The `export` keyword is important. The variable `RIVET_CLI_VERSION` needs to be accessible inside the install script._
 </details>
 
 <details>
-<summary><b>Windows (cmd)</b></summary>
-
-**Install latest version**
-
-```ps1
-powershell -Command "iwr https://raw.githubusercontent.com/rivet-gg/cli/main/install/windows.ps1 -useb | iex"
-```
-
-**Install specific version**
-
-We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI.
+<summary><b>macOS (Intel)</b></summary>
 
 ```sh
-powershell -Command "$env:RIVET_CLI_VERSION='v1.0.0'; iwr https://raw.githubusercontent.com/rivet-gg/cli/$env:RIVET_CLI_VERSION/install/windows.ps1 -useb | iex"
+curl -L https://releases.rivet.gg/toolchain/v2.0.0-rc.5/macos_x86_64/rivet.zip -o rivet.zip
+unzip rivet.zip
+chmod +x rivet
+sudo mv rivet /usr/local/bin/
 ```
 </details>
 
 <details>
-<summary><b>Windows (PowerShell)</b></summary>
-
-**Install latest version**
-
-```
-iwr https://raw.githubusercontent.com/rivet-gg/cli/main/install/windows.ps1 -useb | iex
-```
-
-**Install specific version**
+<summary><b>Linux (x86)</b></summary>
 
-We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI.
-
-```ps1
-$env:RIVET_CLI_VERSION='v1.0.0'
-iwr https://raw.githubusercontent.com/rivet-gg/cli/$env:RIVET_CLI_VERSION/install/windows.ps1 -useb | iex
+```sh
+curl -L https://releases.rivet.gg/toolchain/v2.0.0-rc.5/linux_x86_64/rivet.zip -o rivet.zip
+unzip rivet.zip
+chmod +x rivet
+sudo mv rivet /usr/local/bin/
 ```
 </details>
 
 <details>
-<summary><b>Build from source (<code>cargo install</code>)</b></summary>
+<summary><b>Build from source (`cargo install`)</b></summary>
 
+1. [Install Rust](https://rustup.sh)
+2. Install Rivet
 
 ```sh
 cargo install --git=https://github.com/rivet-gg/toolchain rivet-cli
 ```
 </details>
 
 <details>
-<summary><b>Build from source (<code>cargo build</code>)</b></summary>
+<summary><b>Build from source (`cargo build`)</b></summary>
+
+1. [Install Rust](https://rustup.sh)
+2. Install Rivet
 
 ```sh
-git clone https://github.com/rivet-gg/toolchain
+git clone https://github.com/rivet-gg/toolchain.git
 cd packages/cli
 cargo build
 ```
@@ -109,3 +100,47 @@ Options:
   -h, --help     Print help
   -V, --version  Print version
 ```
+
+## Quick Start
+
+After installation, you can quickly get started with Rivet by following these steps:
+
+1. Initialize a new Rivet project:
+   ```sh
+   rivet init
+   ```
+
+2. Start the development server:
+   ```sh
+   rivet dev
+   ```
+
+3. Deploy your game:
+   ```sh
+   rivet login
+   rivet deploy
+   ```
+## Troubleshooting
+
+If you encounter any issues while using Rivet, try the following:
+
+1. Ensure you're using the latest version of Rivet
+2. Use the `rivet clean` command to remove any artifacts that might be causing problems
+3. Join our [Discord](https://rivet.gg/discord) for support
+
+Please [open an issue](https://github.com/rivet-gg/toolchain/issues) for any issues you run in to.
+
+## Contributing
+
+We welcome contributions to the Rivet Toolchain! If you'd like to contribute, please:
+
+1. Fork the repository
+2. Create a new branch for your feature
+3. Make your changes
+4. Submit a pull request
+
+For more detailed information, see our [contribution guidelines](CONTRIBUTING.md).
+
+## License
+
+Rivet Toolchain is released under the [Apache 2.0 License](LICENSE).