Skip to content

Commit

Permalink
Merge pull request #1266 from uncenter/patch-1
Browse files Browse the repository at this point in the history
Fix typos and capitalization in README
  • Loading branch information
ryansolid authored Jan 19, 2024
2 parents 0aebb40 + 68c0f6e commit 3ef18e9
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

# SolidStart

### Start has just entered a new Beta Phase ###
### Start has just entered a new Beta Phase

v0.4.x marks a significant change in the project. Please check the updated docs and example projects to see how things have changed. A summary of the chances can be found in the [RFC](https://github.com/solidjs/solid-start/discussions/1052).
v0.4.x marks a significant change in the project. Please check the updated docs and example projects to see how things have changed. A summary of the changes can be found in the [RFC](https://github.com/solidjs/solid-start/discussions/1052).

------------------------------------

Expand All @@ -19,9 +19,9 @@ This is the home of the Solid app framework. This is still a **work in progress*
- Server-side rendering (SSR)
- Streaming SSR
- Client-side rendering (CSR)
- Static Site Generation (SSG)
- Static site generation (SSG)
- Streaming
- Build optimizations with Code splitting, tree shaking and dead code elimination
- Build optimizations with code splitting, tree shaking and dead code elimination
- API Routes
- Built on Web standards like Fetch, Streams, and WebCrypto
- Adapters for deployment to all popular platforms
Expand Down Expand Up @@ -54,7 +54,7 @@ bun run dev

### Development

You should use a node version manager [compatible with `.node-version`](https://stackoverflow.com/a/62978089/565877) ([asdf-vm](https://asdf-vm.com/) is a great option mac/linux users)
You should use a Node.js version manager [compatible with `.node-version`](https://stackoverflow.com/a/62978089/565877) ([asdf-vm](https://asdf-vm.com/) is a great option macOS/Linux users)

The monorepo uses `pnpm` as the package manager. To install `pnpm`, run the following command in your terminal.

Expand All @@ -67,9 +67,9 @@ Run `pnpm install` to install all the dependencies for the packages and examples
<details>
<summary><h4>Monorepo & <code>project.json</code> <code>"workspace"</code> support</h4></summary>

If you are using Solid Start within a monorepo that takes advantage of the `package.json` `"workspaces"` property (e.g. [yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/)) with hoisted dependencies (the default for yarn), you must include `solid-start` within the optional `"nohoist"` (for yarn v2 or higher, see further down for instructions) workspaces property.
If you are using SolidStart within a monorepo that takes advantage of the `package.json` `"workspaces"` property (e.g. [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/)) with hoisted dependencies (the default for Yarn), you must include `solid-start` within the optional `"nohoist"` (for Yarn v2 or higher, see further down for instructions) workspaces property.

- _In the following, "workspace root" refers to the root of your repository while "project root" refers to the root of a child package within your repository_
- _In the following, "workspace root" refers to the root of your repository while "project root" refers to the root of a child package within your repository._

For example, if specifying `"nohoist"` options from the workspace root (i.e. for all packages):

Expand Down

0 comments on commit 3ef18e9

Please sign in to comment.