tagline & getting started

README.md

@@ -3,12 +3,10 @@
   <img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/WEBlsp_logo_light.svg" />
 </picture>
 
-A better Language Server for the Web, made with Rust.
+A Language Server for the Web.
 
 (Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), WEBlsp is designed to work with any IDE that supports LSP. Build on top of ~~HTMLlsrs~~ and [CSSlsrs](https://github.com/web-lsp/weblsp/tree/main/crates/csslsrs), our own modern, fast, and reliable Language Services.
 
-This is the root of WEBlsp monorepository, please refer to the list of crates and packages below for more specific information.
-
 ## Quick Links
 
 🐛 [Report a bug](https://github.com/web-lsp/weblsp/issues), please read our [contributing guidelines](https://github.com/web-lsp/weblsp/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/web-lsp/weblsp/blob/main/CODE_OF_CONDUCT.md) first.
@@ -17,7 +15,30 @@ This is the root of WEBlsp monorepository, please refer to the list of crates an
 
 💬 [Join the discussion](https://github.com/web-lsp/weblsp/discussions), if you have any questions, ideas, or suggestions.
 
-## Crates
+## Development
+
+### Getting Started
+
+To get started with WEBlsp, you will need to install the following tools:
+
+- [Rust](https://www.rust-lang.org/tools/install)
+- [Node.js](https://nodejs.org/en/download/)
+- [PNPM](https://pnpm.io/installation)
+- [Just](https://just.systems/)
+- [wasm-bindgen-cli](https://rustwasm.github.io/wasm-bindgen/) (optional, for building WASM binaries)
+- [wasm-opt](https://github.com/WebAssembly/binaryen) (optional, for WASM benchmarks and releases)
+
+Useful commands:
+
+| Command           | Description                                             |
+| ----------------- | ------------------------------------------------------- |
+| `just install`    | Install NPM dependencies across all crates and packages |
+| `just build`      | Build WEBlsp crate and every language services          |
+| `just build-wasm` | Build WASM packages                                     |
+| `just test`       | Run tests for all crates and packages                   |
+| `just benchmark`  | Run native, WASM, and E2E benchmarks                    |
+
+### Crates
 
 WEBlsp is a monorepo that contains the following crates (Rust packages):
 
@@ -26,7 +47,7 @@ WEBlsp is a monorepo that contains the following crates (Rust packages):
 | `weblsp`  | The main Language Server | WIP       | [README.md](./crates/weblsp/README.md)  |
 | `csslsrs` | CSS Language Service     | WIP       | [README.md](./crates/csslsrs/README.md) |
 
-## Packages
+### Packages
 
 Additionally, WEBlsp contains the following NPM packages (JavaScript packages):
 

SECURITY.md

@@ -9,20 +9,30 @@ The following versions of our projects are currently supported with security upd
 | WEBlsp  | 0.x.x   | :white_check_mark: |
 | CSSlsrs | 0.x.x   | :white_check_mark: |
 
+## What is a Security Vulnerability?
+
+A security vulnerability is a flaw or weakness in a system's design, implementation, operation, or management that could be exploited to violate the system's security policy. (Source: OWASP)
+
+Please note that we will not accept reports related to vulnerabilities in other software, such as the IDEs that use our server or our dependencies. Additionally, we reserve the right to close reports that describe scenarios deemed highly unlikely or far-fetched.
+
 ## Reporting a Vulnerability
 
 We take security issues very seriously. If you discover a vulnerability, please report it through our private reporting form: [Report a Security Vulnerability](https://github.com/web-lsp/weblsp/security/advisories/new).
 
 ### Guidelines for Reporting
+
 - Do **not** report vulnerabilities publicly via issues or discussions.
 - Please provide as much detail as possible about the vulnerability to help us investigate and resolve it quickly.
 
 ### What to Expect
+
 - You will receive an acknowledgement of your report within **48 hours** (working days).
-- We will work to fix the issue as soon as possible. In most cases, a fix will be published within **one week** of confirming the vulnerability.
+- If the report is valid, in most cases, a fix will be published within **one week** of confirming the vulnerability.
+
+Keep in mind that we are an open-source project, and our team is composed of volunteers. We will do our best to address the issue promptly, but we appreciate your understanding and patience.
 
 ### Post-Fix Communication
-Once the fix is deployed, a **public security advisory** will be published here: [Security Advisories](https://github.com/web-lsp/weblsp/security/advisories).  
-If applicable, credit will be given to the reporter for their responsible disclosure.
+
+Once the fix is deployed, a **public security advisory** will be published here: [Security Advisories](https://github.com/web-lsp/weblsp/security/advisories). If applicable, credit will be given to the reporter for their responsible disclosure.
 
 We greatly appreciate your efforts to help us maintain the security of our projects.

crates/csslsrs/README.md

@@ -3,7 +3,7 @@
   <img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/CSSlsrs_logo_light.svg" />
 </picture>
 
-A CSS Language Service made with Rust.
+A Language Service for CSS.
 
 (Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), CSSlsrs can be integrated into Language Servers written in Rust or JavaScript/TypeScript (via WebAssembly). Thanks to [Biome](https://biomejs.dev/)'s parser, we deliver a fast and efficient language service, designed to improve your productivity when working with CSS.
 
@@ -38,11 +38,3 @@ A CSS Language Service made with Rust.
 | Validation          | ❌       | ✅      | -                      |
 | Custom data         | ❌       | ✅      | -                      |
 | Super-set of CSS    | ❌       | ✅      | -                      |
-
-## Getting Started
-
-WIP.
-
-## Building
-
-WIP.

crates/weblsp/README.md

@@ -3,7 +3,7 @@
   <img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/WEBlsp_logo_light.svg" />
 </picture>
 
-A better Language Server for the Web, made with Rust.
+A Language Server for the Web.
 
 (Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), WEBlsp is designed to work with any IDE that supports LSP. 
 
@@ -18,13 +18,3 @@ This crate contains the Language Server implementation in Rust. WEBlsp receives
 🚨 [Report a security vulnerability](https://github.com/web-lsp/weblsp/security/advisories/new), and be sure to review our [security policy](https://github.com/web-lsp/weblsp/blob/main/SECURITY.md).
 
 💬 [Join the discussion](https://github.com/web-lsp/weblsp/discussions), if you have any questions, ideas, or suggestions.
-
-## Getting Started
-
-WIP.
-
-## Building
-
-WIP.
-
-

packages/csslsrs/README.md

@@ -3,7 +3,7 @@
   <img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/CSSlsrs_logo_light.svg" />
 </picture>
 
-A CSS Language Service made with Rust, for the JavaScript/TypeScript ecosystem.
+A Language Service for CSS.
 
 (Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), CSSlsrs can be integrated into Language Servers written in Rust or JavaScript/TypeScript (via WebAssembly). Thanks to [Biome](https://biomejs.dev/)'s parser, we deliver a fast and efficient language service, designed to improve your productivity when working with CSS.
 
@@ -18,11 +18,3 @@ This package contains the WASM implementation of [CSSlsrs](https://github.com/we
 🚨 [Report a security vulnerability](https://github.com/web-lsp/weblsp/security/advisories/new), and be sure to review our [security policy](https://github.com/web-lsp/weblsp/blob/main/SECURITY.md).
 
 💬 [Join the discussion](https://github.com/web-lsp/weblsp/discussions), if you have any questions, ideas, or suggestions.
-
-## Getting Started
-
-WIP.
-
-## Building
-
-WIP.

packages/vscode/README.md

@@ -3,7 +3,7 @@
   <img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/WEBlsp_logo_light.svg" />
 </picture>
 
-A better Language Server for the Web, made with Rust.
+A Language Server for the Web, now in VSCode.
 
 (Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~
 

packages/vscode/package.json

@@ -2,7 +2,7 @@
 	"name": "@weblsp/vscode",
 	"displayName": "WEBlsp",
 	"version": "1.0.0",
-	"description": "A better Language Server for the Web, made with Rust — WORK IN PROGRESS ⚠️",
+	"description": "A Language Server for the Web — WORK IN PROGRESS ⚠️",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/web-lsp/weblsp"