update readme

This commit is contained in:
Zynh Ludwig 2024-06-10 20:55:37 -07:00
parent 6893fb04c9
commit 7111e9d4a4

View file

@ -2,19 +2,10 @@
Everything you need to build a Solid project, powered by [`solid-start`](https://start.solidjs.com);
## Creating a project
```bash
# create a new project in the current directory
npm init solid@latest
# create a new project in my-app
npm init solid@latest my-app
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've created a project and installed dependencies with `npm install`
(or `pnpm install` or `yarn`), start a development server:
```bash
npm run dev
@ -25,8 +16,11 @@ npm run dev -- --open
## Building
Solid apps are built with _presets_, which optimise your project for deployment to different environments.
Solid apps are built with _presets_, which optimise your project
for deployment to different environments.
By default, `npm run build` will generate a Node app that you can run with `npm start`. To use a different preset, add it to the `devDependencies` in `package.json` and specify in your `app.config.js`.
By default, `npm run build` will generate a Node app that you can run with `npm start`.
To use a different preset, add it to the `devDependencies` in `package.json`
and specify in your `app.config.js`.
## This project was created with the [Solid CLI](https://solid-cli.netlify.app)