Skip to content

Commit

Permalink
docs: enhance install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cab-mikee committed Dec 20, 2024
1 parent 847c33e commit 8a1415a
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ export default withPwa(
title: 'rpx',
description: 'A modern, fast reverse proxy. For a better local development environment.',
metaChunk: true,
cleanUrls: true,

head: [
['link', { rel: 'icon', type: 'image/svg+xml', href: './images/logo-mini.svg' }],
Expand Down
83 changes: 78 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,86 @@

# Install

## Bun & Node.js

```bash
bun install -d @stacksjs/rpx
npm install -g @stacksjs/rpx

# or, invoke immediately
bunx @stacksjs/rpx
npx @stacksjs/rpx
```

_We are looking to publish this package npm under the name `rpx`. We are also hoping npm will release the name for us._

## Binaries

For now, you can download the `rpx` binaries from the [releases page](https://github.com/stacksjs/rpx/releases/tag/v0.9.1). Choose the binary that matches your platform and architecture:

## macOS (Darwin)

For M1/M2 Macs (arm64):

```bash
# Download the binary
curl -L https://github.com/stacksjs/rpx/releases/download/v0.9.1/rpx-darwin-arm64 -o rpx

# Make it executable
chmod +x rpx

# Move it to your PATH
mv rpx /usr/local/bin/rpx
```

<!-- _Alternatively, you can install:_
For Intel Macs (amd64):

```bash
brew install rpx # wip
pkgx install rpx # wip
``` -->
# Download the binary
curl -L https://github.com/stacksjs/rpx/releases/download/v0.9.1/rpx-darwin-x64 -o rpx

# Make it executable
chmod +x rpx

# Move it to your PATH
mv rpx /usr/local/bin/rpx
```

## Linux

For ARM64:

```bash
# Download the binary
curl -L https://github.com/stacksjs/rpx/releases/download/v0.9.1/rpx-linux-arm64 -o rpx

# Make it executable
chmod +x rpx

# Move it to your PATH
mv rpx /usr/local/bin/rpx
```

For x64:

```bash
# Download the binary
curl -L https://github.com/stacksjs/rpx/releases/download/v0.9.1/rpx-linux-x64 -o rpx

# Make it executable
chmod +x rpx

# Move it to your PATH
mv rpx /usr/local/bin/rpx
```

## Windows

For x64:

```bash
# Download the binary
curl -L https://github.com/stacksjs/rpx/releases/download/v0.9.1/rpx-windows-x64.exe -o rpx.exe

# Move it to your PATH (adjust the path as needed)
move rpx.exe C:\Windows\System32\rpx.exe
```

0 comments on commit 8a1415a

Please sign in to comment.