chore(website): Getting Started copy
MODIFY
website/src/_includes/docs/getting-started.md
website/src/_includes/docs/getting-started.md
## Getting Started
-Rome works on Linux, macOS, and Windows operative systems.
+Rome works on Linux, macOS, and Windows.
-On macOS, Linux and Windows we both support x64 and ARM architectures.
+For all operating systems, we support both x86_64 and ARM architectures.
-Install Rome using any of the following installation methods.
+Install Rome using any of the following methods.
-### Install Rome official VS Code extension
+### Install official Rome VS Code extension
You can use Rome by installing the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=rome.rome) from the marketplace.
-Rome currently doesn't support other editors than VS Code. Let us know if you're interested in getting support for another editor to help us prioritize our work.
+Rome currently doesn't support other editors than VS Code. [Let us know](https://github.com/rome/tools/discussions/categories/suggestions) if you would like support for another editor.
### Install Rome CLI
-Install `rome` using your preferred node package manager.
+Install `rome` using your preferred node package manager. We require a minimum Node version of v14.18.
-> RECOMMENDATION: we advise to **not** install the binary globally, instead install the binary
-> locally to your project or use `npx/pnpx/yarn dlx` in order to leverage the CLI.
+> NOTE: we recommend **not** installing the binary globally, instead please install the binary
+> locally to your project. You can also use `npx`, `pnpx` or `yarn dlx` to run `rome@next`.
| Package manager | Instructions |
-|-------------------------------|----------------------|
-| [npm](https://www.npmjs.com/) | `npm i rome@next` |
-| [pnpm](https://pnpm.io/) | `pnpm i rome@next` |
-| [yarn](https://yarnpkg.com/) | `yarn add rome@next` |
+|-------------------------------|-------------------------|
+| [npm](https://www.npmjs.com/) | `npm i -D rome@next` |
+| [pnpm](https://pnpm.io/) | `pnpm i -D rome@next` |
+| [yarn](https://yarnpkg.com/) | `yarn add -D rome@next` |
+
+If you install the CLI locally, use the [scripts field](https://docs.npmjs.com/cli/v8/using-npm/scripts) of your package.json to run Rome. For instance:
+
+```json
+{
+ "scripts": {
+ "format": "rome format ."
+ }
+}
+```
+
+Then you can run:
+```bash
+npm run format
+yarn format
+pnpm run format
+```
### Install Rome in your CI pipeline
#### GitHub Actions
-Please refer to the documentation of the [`setup-rome` action](https://github.com/rome/setup-rome#usage) for more information about its configuration:
+Please refer to the [`setup-rome` action documentation](https://github.com/rome/setup-rome#usage) for more information about its configuration:
```yaml
steps:
@@ -50,11 +67,12 @@ curl -L https://github.com/rome/tools/releases/download/latest/rome-<OS>-<ARCH>
chmod +x rome
```
-Where `OS` and `ARCH` follow the Node.js syntax convention:
+Where `<OS>` and `<ARCH>` follow the Node.js syntax convention:
-- `OS` is one of the following values: `win32`, `darwin` or `linux`
-- `ARCH` is one of the following values: `arm64` or `x64`
+- `<OS>` is one of the following values: `win32`, `darwin` or `linux`
+- `<ARCH>` is one of the following values: `arm64` or `x64`
+> NOTE: For Windows Subsystem for Linux (WSL), please use `linux` as your OS
| | `win32` | `darwin` | `linux` |
|---------|-----------------|------------------|-----------------|
@@ -64,7 +82,7 @@ Where `OS` and `ARCH` follow the Node.js syntax convention:
Please make sure to choose the correct architecture from the [releases page](https://github.com/rome/tools/releases).
-## After installation
+## Post-Installation
- check the [formatter section](/formatter#use-the-formatter-with-the-cli) for options and commands;
- check the options available in the [VS Code extension](/formatter#use-the-formatter-with-the-vscode-extension)

chore(website): Getting Started copy (#2343)