Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<img src="https://img.shields.io/badge/Typecheck-Ty-261230?style=flat-square&logo=astral&logoColor=white" alt="ruff">
</a>
<a href="https://codecov.io/gh/relaycli/relay">
<img src="https://img.shields.io/codecov/c/github/relaycli/relay.svg?logo=codecov&style=flat-square&token=fkT0jQefhO" alt="Test coverage percentage">
<img src="https://img.shields.io/codecov/c/github/relaycli/relay.svg?logo=codecov&style=flat-square&token=48QKJKDCYP" alt="Test coverage percentage">
</a>
</p>
<p align="center">
Expand Down Expand Up @@ -68,7 +68,7 @@ That's it!

#### 1 - Install the CLI
```shell
uv pip install relaycli
uv pip install --system relaycli
```
#### 2 - Connect your email account
```shell
Expand Down Expand Up @@ -96,4 +96,4 @@ Copyright (C) 2025, Relay.
This program is licensed under the Apache License 2.0.
See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Frelaycli%2Fcontribution-api.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Frelaycli%2Frelay?ref=badge_large&issueType=license)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Frelaycli%2Frelay.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Frelaycli%2Frelay?ref=badge_large&issueType=license)
19 changes: 12 additions & 7 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Relay",
"appearance": {
"default": "dark",
"strict": false
},
"colors": {
"primary": "#16A34A",
"light": "#07C983",
"dark": "#15803D"
"primary": "#746ADB",
"light": "#8B82E6",
"dark": "#5E52B0"
},
"favicon": "/logo/dark.svg",
"favicon": "/favicon.svg",
"navigation": {
"tabs": [
{
Expand Down Expand Up @@ -65,8 +69,8 @@
}
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg",
"light": "/logo/black.svg",
"dark": "/logo/white.svg",
"href": "https://relaycli.com"
},
"navbar": {
Expand All @@ -92,7 +96,8 @@
"metatags": {
"og:title": "Relay",
"og:description": "Email infrastructure for modern applications"
}
},
"image": "/meta/og.png"
},
"contextual": {
"options": [
Expand Down
34 changes: 29 additions & 5 deletions docs/documentation/getting-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: 'Quickstart'
description: 'From zero to "Hello inbox" in under 5 minutes'
---

## Build your first e-mail app (hosted cloud)
## Manage your emails in your console

<Steps>
<Step title="Grab your mailbox credentials">
Expand All @@ -25,11 +25,35 @@ description: 'From zero to "Hello inbox" in under 5 minutes'
Copy your account password
</Tab>
</Tabs>
</Step>
<Step title="Install a Python package manager">
<Tabs>
<Tab title="uv">
#### Using the standalone installer
<CodeGroup>
```shell title="macOS & Linux"
curl -LsSf https://astral.sh/uv/install.sh | sh
```
```shell title="Windows"
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
</CodeGroup>
#### Using Pypi
```shell
pip install uv
```

If you encounter issues, refer to the [official documentation](https://docs.astral.sh/uv/getting-started/installation).
</Tab>
<Tab title="pip">
Follow the [official documentation](https://pip.pypa.io/en/stable/installation/).
</Tab>
</Tabs>
</Step>
<Step title="Install the CLI">
<CodeGroup>
```shell title="uv" icon="python"
uv pip install relaycli
```shell title="uv"
uv pip install --system relaycli
```
```shell title="pip" icon="python"
pip install relaycli
Expand All @@ -55,7 +79,7 @@ description: 'From zero to "Hello inbox" in under 5 minutes'
</CodeGroup>

</Step>
<Step title="Build an email digest (optional)">
Now it's your turn!.
<Step title="Make something cool">
Now it's your turn!
</Step>
</Steps>
4 changes: 4 additions & 0 deletions docs/logo/black.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 0 additions & 5 deletions docs/logo/dark.svg

This file was deleted.

5 changes: 0 additions & 5 deletions docs/logo/light.svg

This file was deleted.

4 changes: 4 additions & 0 deletions docs/logo/white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/meta/og.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.