chore: better package.json and readme
DELETE
README.md
-<p align="center">
- <img alt="Rome's logo depicting an ancient Roman arch with the word Rome to its side" src="assets/PNG/logo_transparent.png#gh-light-mode-only" width="700">
- <img alt="Rome's logo depicting an ancient Roman arch with the word Rome to its side" src="assets/PNG/logo_white_yellow_transparent.png#gh-dark-mode-only" width="700">
-</p>
-
-
-<!-- This intro is synced with the website via the `./rome run scripts/generate-files/website-intro` script. Make sure you run it after modifying anything between these comments. -->
-<!-- INTRO START -->
-**Rome** is a formatter, linter, bundler, and [more](https://rome.tools/#development-status) for JavaScript, TypeScript, JSON, HTML, Markdown, and CSS.
-
-**Rome** is designed to replace [Babel](https://babeljs.io/), [ESLint](https://eslint.org/), [webpack](https://webpack.js.org/), [Prettier](https://prettier.io/), [Jest](https://jestjs.io/), and others.
-
-**Rome** unifies functionality that has previously been separate tools. Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelizing work, caching, and configuration.
-
-**Rome** has strong conventions and aims to have minimal configuration. Read more about our [project philosophy](https://rome.tools/#philosophy).
-
-**Rome** is [written in Rust](https://rome.tools/blog/2021/09/21/rome-will-be-rewritten-in-rust).
-
-**Rome** has first-class IDE support, with a sophisticated parser that represents the source text in full fidelity
-and top-notch error recovery.
-
-**Rome** is [MIT licensed](https://github.com/rome/tools/tree/main/LICENSE) and moderated under the [Contributor Covenant Code of Conduct](https://github.com/rome/tools/tree/main/CODE_OF_CONDUCT.md).
-<!-- INTRO END -->
-
-## Status
-
-The current areas of focus are:
-- to make the formatter **more compatible with Prettier** and format JSX. See [#2262](https://github.com/rome/tools/issues/2262) and [#2403](https://github.com/rome/tools/issues/2403).
-- starts the foundations for analyzers (linting). See [2488](https://github.com/rome/tools/issues/2488)
-
-## Philosophy
-
-The project philosophy can be found on our [website](https://rome.tools/#philosophy).
-
-## Community
-
-Contribution and development instructions can be found in [CONTRIBUTING](./CONTRIBUTING.md).
-
-Additional project coordination and real-time discussion happens on our [Discord server](https://discord.gg/rome). Remember that all activity on the Discord server is still moderated and will be strictly enforced under the project's [Code of Conduct](./CODE_OF_CONDUCT.md).

ADD
README.md
+./npm/rome/README.md
\ No newline at end of file

MODIFY
npm/rome/README.md
npm/rome/README.md
-# Rome
+<p align="center">
+ <img alt="Rome's logo depicting an ancient Roman arch with the word Rome to its side" src="https://raw.githubusercontent.com/rome/tools/main/assets/PNG/logo_transparent.png#gh-light-mode-only" width="700">
+ <img alt="Rome's logo depicting an ancient Roman arch with the word Rome to its side" src="https://raw.githubusercontent.com/rome/tools/main/assets/PNG/logo_white_yellow_transparent.png#gh-dark-mode-only" width="700">
+</p>
+
+**Rome** is a formatter, linter, bundler, and [more](https://rome.tools/#development-status) for JavaScript, TypeScript, JSON, HTML, Markdown, and CSS.
+
+**Rome** is designed to replace [Babel](https://babeljs.io/), [ESLint](https://eslint.org/), [webpack](https://webpack.js.org/), [Prettier](https://prettier.io/), [Jest](https://jestjs.io/), and others.
+
+**Rome** unifies functionality that has previously been separate tools. Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelizing work, caching, and configuration.
+
+**Rome** has strong conventions and aims to have minimal configuration. Read more about our [project philosophy](https://rome.tools/#philosophy).
+
+**Rome** is [written in Rust](https://rome.tools/blog/2021/09/21/rome-will-be-rewritten-in-rust).
+
+**Rome** has first-class IDE support, with a sophisticated parser that represents the source text in full fidelity
+and top-notch error recovery.
+
+**Rome** is [MIT licensed](https://github.com/rome/tools/tree/main/LICENSE) and moderated under the [Contributor Covenant Code of Conduct](https://github.com/rome/tools/tree/main/CODE_OF_CONDUCT.md).
-Official Node.js bindings of Rome.
## Installation
@@ -13,10 +30,23 @@ npm i rome@next
Format files:
```shell
-rome format ./path ./path/to/file.js
+rome format --write ./path ./path/to/file.js
```
For complete documentation, please visit the [official website].
-[official website]: https://rome.tools/#use-the-formatter-with-the-cli
+## Philosophy
+
+The project philosophy can be found on our [website](https://rome.tools/#philosophy).
+
+## Community
+
+Contribution and development instructions can be found in [CONTRIBUTING](./CONTRIBUTING.md).
+
+Additional project coordination and real-time discussion happens on our [Discord server](https://discord.gg/rome). Remember that all activity on the Discord server is still moderated and will be strictly enforced under the project's [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+
+
+[official website]: https://rome.tools/
+

MODIFY
npm/rome/package.json
npm/rome/package.json
"scripts": {
"postinstall": "node scripts/postinstall.js"
},
+ "homepage": "https://rome.tools",
+ "author": "Sebastian McKenzie",
+ "bugs": "https://github.com/rome/tools/issues",
+ "description": "Rome is a toolchain for the web: formatter, linter and more",
"files": [
"bin/rome",
"scripts/postinstall.js",
"README.md"
],
+ "keywords": [
+ "JavaScript",
+ "TypeScript",
+ "format",
+ "lint",
+ "toolchain"
+ ],
"engines": {
- "node": ">=14.18.0"
+ "node": ">=14.*"
},
"license": "MIT"
}
\ No newline at end of file

chore: better package.json and readme (#2819)