---
title: "Example Stack README in Pulumi Cloud"
description: "A minimal project showing a Stack README"
url: "https://www.pulumi.com/dev/examples/stack-readme-ts/"
image: "https://www.pulumi.com/assets/og/dev/examples/stack-readme-ts.png"
---

# Example Stack README in Pulumi Cloud

A minimal project showing a Stack README

- Source on GitHub: https://github.com/pulumi/examples/tree/master/stack-readme-ts

## Get started with this example

This example lives in the [pulumi/examples](https://github.com/pulumi/examples/tree/master/stack-readme-ts) repo. Pull down just this directory to follow along:

```bash
git clone --filter=blob:none --sparse https://github.com/pulumi/examples pulumi-examples
git -C pulumi-examples sparse-checkout set stack-readme-ts
cd pulumi-examples/stack-readme-ts
```

This example shows how to set up a [Stack Readme](https://www.pulumi.com/docs/intro/pulumi-cloud/projects-and-stacks/#stack-readme) in typescript.

Stack READMEs in [Pulumi Cloud](https://app.pulumi.com/) dynamically update based on Stack Outputs. Stack READMEs interpolate output variables on the stack (${outputs.instances[0].ARN}) so that each stack can construct links to dashboards, shell commands, and other pieces of documentation. All of this content stays up to date as you stand up new stacks, rename resources, and refactor your infrastructure.

To set a Stack README, simply set Stack Output named `readme` to the value of your templated Stack README file. In this example, we've called the file `Pulumi.README.md`


#### Example Project Structure
`./index.ts`
```typescript
import { readFileSync } from "fs";
export const strVar = "foo";
export const arrVar = ["fizz", "buzz"];
// add readme to stack outputs. must be named "readme".
export const readme = readFileSync("./Pulumi.README.md").toString();
```


`./Pulumi.README.md`
```markdown
# Stack README

Full markdown support! Substitute stack outputs dynamically so that links can depend on your infrastructure! Link to dashboards, logs, metrics, and more.

1. Reference a string stack output: ${outputs.strVar}
2. Reference an array stack output: ${outputs.arrVar[1]}
```

#### How to View the Rendered Stack README

Run `pulumi up`, then go to the Pulumi console by running `pulumi console`. Then click the README tab.