Skip to content

Commit ef81266

Browse files
committed
docs: Update examples documentation with Node.js and Bun examples
1 parent f950d33 commit ef81266

File tree

2 files changed

+7
-21
lines changed

2 files changed

+7
-21
lines changed

apps/docs/content/docs/examples.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ description: Explore our collection of examples to get started with ark.env
77
## Examples
88

99
| Name | Description |
10-
|------|-------------|
11-
| [basic](https://github.com/yamcodes/ark.env/tree/main/examples/basic) | A minimal example showing *how to use `ark.env` in a [Bun](https://bun.sh/) application*. Perfect for learning the fundamentals. |
10+
| --- | --- |
11+
| [`basic`](./basic) | A minimal example showing *how to use `ark.env` in a [Node.js](https://nodejs.org/) application*. Perfect for learning the fundamentals. |
12+
| [`with-bun`](./with-bun) | A minimal example showing *how to use `ark.env` in a [Bun](https://bun.sh/) application*. Perfect for learning the fundamentals. |
1213

1314
## Next steps
1415

examples/README.md

+4-19
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,10 @@ This directory contains a collection of example projects that demonstrate variou
44

55
## Examples
66

7-
- [`basic`](./basic) - A minimal example showing *how to use `ark.env` in a [Bun](https://bun.sh/) application*. Perfect for learning the fundamentals.
8-
9-
## Running an example
10-
11-
Each example is a self-contained project with its own `package.json` and dependencies. To run an example:
12-
13-
1. Navigate to the example directory:
14-
```bash
15-
cd examples/<example-name>
16-
```
17-
18-
2. Install dependencies:
19-
```bash
20-
bun install
21-
```
22-
23-
3. Follow the example-specific instructions in its README.
7+
| Name | Description |
8+
| --- | --- |
9+
| [`basic`](./basic) | A minimal example showing *how to use `ark.env` in a [Node.js](https://nodejs.org/) application*. Perfect for learning the fundamentals. |
10+
| [`with-bun`](./with-bun) | A minimal example showing *how to use `ark.env` in a [Bun](https://bun.sh/) application*. Perfect for learning the fundamentals. |
2411

2512
## Contributing an example
2613

@@ -31,8 +18,6 @@ New examples are welcome! If you'd like to contribute an example:
3118
3. Ensure the example is self-contained and includes all necessary files
3219
4. Add the example to this README's list of examples
3320

34-
## Structure
35-
3621
Each example follows this basic structure:
3722
```
3823
examples/<example-name>/

0 commit comments

Comments
 (0)