Skip to content

Commit 1678f34

Browse files
authored
Minor readme update (#1946)
1 parent 5833629 commit 1678f34

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66
[![Discord](https://img.shields.io/discord/722131463138705510?style=for-the-badge&color=5865F2)](https://discord.com/invite/solidjs)
77
[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/solidjs?style=for-the-badge&color=FF4500)](https://www.reddit.com/r/solidjs/)
88

9-
**SolidStart** brings fine-grained reactivity fullstack with full flexibility. Built with features like unified rendering and isomorphic code execution, SolidStart enables you to create highly performant and scalable web applications. Explore the official [documentation](https://docs.solidjs.com/solid-start) for detailed guides and examples.
9+
**SolidStart** brings fine-grained reactivity fullstack with full flexibility. Built with features like unified rendering and isomorphic code execution, SolidStart enables you to create highly performant and scalable web applications.
10+
11+
Explore the official [documentation](https://docs.solidjs.com/solid-start) for detailed guides and examples.
1012

1113
## Core Features
1214

1315
- **All Rendering Modes**:
14-
- Server-Side Rendering (SSR) with sync, async, and stream [modes](https://docs.solidjs.com/solid-start/reference/server/create-handler).
15-
- Client-Side Rendering (CSR)
16-
- Static Site Generation (SSG)
16+
- Server-Side Rendering _(SSR)_ with sync, async, and stream [modes](https://docs.solidjs.com/solid-start/reference/server/create-handler)
17+
- Client-Side Rendering _(CSR)_
18+
- Static Site Generation _(SSG)_
1719
- **TypeScript**: Full integration for robust, type-safe development
1820
- **File-Based Routing**: Intuitive routing based on your project’s file structure
1921
- **API Routes**: Dedicated server-side endpoints for seamless API development
@@ -25,28 +27,32 @@
2527

2628
### Installation
2729

28-
Create a template project with your preferred package manager:
30+
Create a template project with your preferred package manager
2931

3032
```bash
3133
# using npm
3234
npm create solid@latest -- --solidstart
35+
```
3336

37+
```bash
3438
# using pnpm
3539
pnpm create solid@latest --solidstart
40+
```
3641

42+
```bash
3743
# using bun
3844
bun create solid@latest --solidstart
3945
```
4046

41-
1. Follow the CLI prompts to set up your project.
42-
2. Navigate to your project directory and install dependencies:
47+
1. Follow the CLI prompts to set up your project
48+
2. Navigate to your project directory and install the dependencies
4349

4450
```bash
4551
cd <project-name>
4652
npm install # or pnpm install or bun install
4753
```
4854

49-
3. Start the development server:
55+
3. Start the development server
5056

5157
```bash
5258
npm run dev # or pnpm dev or bun dev
@@ -66,32 +72,29 @@ Learn more about routing in the [documentation](https://docs.solidjs.com/solid-s
6672

6773
## Adapters
6874

69-
Configure adapters in `app.config.ts` to deploy to platforms like Vercel, Netlify, Cloudflare, and others:
75+
Configure adapters in `app.config.ts` to deploy to platforms like Vercel, Netlify, Cloudflare, and others
7076

7177
```ts
7278
import { defineConfig } from "@solidjs/start/config";
7379

7480
export default defineConfig({
75-
ssr: true, // false for client-side rendering
81+
ssr: true, // false for client-side rendering only
7682
server: { preset: "vercel" },
7783
});
7884
```
7985

80-
Presets also include runtimes like Node.js, Bun or Deno. For example, the `node-server` preset enables hosting on your server. Learn more about [`defineConfig`](https://docs.solidjs.com/solid-start/reference/config/define-config).
86+
Presets also include runtimes like Node.js, Bun or Deno. For example, the `node-server` preset enables hosting on your server.
87+
Learn more about [`defineConfig`](https://docs.solidjs.com/solid-start/reference/config/define-config).
8188

8289
## Building for Production
8390

84-
Generate production-ready bundles:
91+
Generate production-ready bundles
8592

8693
```bash
8794
npm run build # or pnpm build or bun build
8895
```
8996

90-
The output is saved to the `dist/` directory. Then, start the server:
91-
92-
```bash
93-
npm start # or pnpm start or bun start
94-
```
97+
After the build completes, you’ll be guided through deployment for your specific preset.
9598

9699
## Contributing
97100

0 commit comments

Comments
 (0)