From 2efaae7da97b0da7f8d9fa34f9df2717e9ecac3d Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 13 Oct 2023 21:16:16 +0000 Subject: [PATCH] Add samples overview --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 61ea7689..9acbc809 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,22 @@ This repository contains the source code for quickstarts, reference apps, and tutorials for Project Radius. -To try out one of these samples, visit https://radapp.dev +To try out one of these samples, visit https://docs.radapp.dev -## Categories +## Codespace -The samples repo is broken down into three categories: +The current repository offers a codespace setup with Radius and its dependencies installed. Try it out for free! -| Sample category | Description | Docs | -|-----------------|-------------|------| -| [First app](demo/) | The main guide to try out and learn the breadth of Project Radius concepts and features | [First-app](https://radapp.dev/getting-started/first-app/) | -| [Quickstarts](quickstarts/) | Focused how-to guides on specific Project Radius scenarios and features | [Quickstarts](https://radapp.dev/getting-started/quickstarts/) | -| [Reference apps](reference-apps/) | Templates showing "radified" applications that can be used as a starting point for your own apps | [Reference apps](https://radapp.dev/getting-started/reference-apps/) | +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/radius-project/samples) -## Codespace +## Samples -The current repository offers a codespace setup with Radius and its dependencies installed. At startup time the codespace will automatically create a Radius local development environment. For more instructions on how to use the codespace see the official docs page: https://docs.radapp.dev/getting-started/install/ +| Sample | Description | +|--------|-------------| +| **demo** | The "swiss army knife" sample for Radius. Displays environment variables, networking information, Radius connections, and more. +| **aws** | A simple app to interact with AWS S3 +| **aws-sqs** | A simple app to interact with AWS SQS +| **dapr** | A 2-tier app leveraging Dapr building blocks +| **eshop** | A Rad-ified version of eShop on Containers, the .NET reference app +| **eshop-dapr** | A Rad-ified version of eShop on Dapr +| **volumes** | An app to interact with mounted volumes