Skip to content

Commit d3b1f7b

Browse files
committed
docs: improve README clarity
1 parent d0ff6ae commit d3b1f7b

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@
3636
<img src="https://img.shields.io/github/actions/workflow/status/techfusionid/elysia-production-template/ci.yml?label=CI&logo=github&style=flat" alt="CI">
3737
</a>
3838
<img src="https://img.shields.io/badge/OpenAPI-documented-6BA539?logo=openapi&style=flat" alt="OpenAPI">
39+
<a href="https://github.com/techfusionid/elysia-production-template/generate">
40+
<img src="https://img.shields.io/badge/use%20this-template-2ea44f?style=flat-square" />
41+
</a>
3942
</p>
4043

4144
## Features
@@ -55,7 +58,7 @@
5558

5659
## Why use this starter?
5760

58-
**Elysia.js is fast.** It's currently the fastest framework in the Bun ecosystem, with [benchmarks showing performance](https://elysiajs.com/at-glance.html#performance) that can match Golang and Rust frameworks.
61+
**Elysia.js is fast.** It's currently one of the fastest frameworks in the Bun ecosystem, with [benchmarks showing performance](https://elysiajs.com/at-glance.html#performance) that can match Golang and Rust frameworks (based on TechEmpower Benchmarks).
5962

6063
**The problem?** Setting up Authentication, ORM, Docker, and logging from scratch for a production-ready app takes hours.
6164

@@ -68,9 +71,21 @@ This boilerplate provides a **simple, ready-to-use, production-grade foundation*
6871
- Keep full control over configuration while avoiding boilerplate fatigue
6972
- Use modern, type-safe tooling without framework lock-in
7073

74+
---
75+
7176
## Quick Start
7277

73-
**Clone the repo:**
78+
### 1. Use This Template (Recommended)
79+
80+
Click the green **"Use this template"** button at the top of this repo — or use the direct link:
81+
82+
👉 [**Create from template**](https://github.com/techfusionid/elysia-production-template/generate)
83+
84+
> Creates a clean repo without git history.
85+
86+
### 2. Clone the repository (Alternative)
87+
88+
If you prefer cloning manually:
7489

7590
```bash
7691
git clone https://github.com/techfusionid/elysia-production-template.git
@@ -164,6 +179,8 @@ Log verbosity can be controlled using the `LOG_LEVEL` environment variable.
164179
bun run dev # Start dev server with hot reload
165180
```
166181

182+
---
183+
167184
**🐳 Local Development with Docker PostgreSQL**
168185

169186
For local development, it's recommended to run PostgreSQL via Docker
@@ -388,7 +405,7 @@ This project aims to stay **simple, production-focused, and easy to extend**, so
388405

389406
---
390407

391-
## How to contribute
408+
### How to contribute
392409

393410
1. Fork this repository
394411
2. Create a new branch from `main`

0 commit comments

Comments
 (0)