chore: add basic guide (#175)

Co-authored-by: Copilot <[email protected]>

Author: hardfist

GUIDE.md

@@ -0,0 +1,68 @@
+# Rslint Guide
+
+This guide provides basic documentation for using Rslint, a high-performance JavaScript and TypeScript linter written in Go.
+
+## Installation
+
+```bash
+# Install via npm
+npm install @rslint/core
+
+# Install via pnpm
+pnpm add @rslint/core
+
+# Install via yarn
+yarn add @rslint/core
+```
+
+## Basic Usage
+
+### Command Line Interface
+
+```bash
+# use default rslint.json
+rslint
+# use custom configuration file
+rslint --config rslint.json
+
+# Lint with auto-fix
+rslint --fix .
+
+# Show help
+rslint --help
+```
+
+### Configuration
+
+**rslint.json**
+
+```json
+[
+  {
+    // ignore files and folders for linting
+    "ignores": ["./files-not-want-lint.ts", "./tests/**/fixtures/**.ts"],
+    "languageOptions": {
+      "parserOptions": {
+        // Rslint will lint all files included in your typescript projects defined here
+        // support lint multi packages in monorepo
+        "project": ["./tsconfig.json", "packages/app1/tsconfig.json"]
+      }
+    },
+    // same configuration as https://typescript-eslint.io/rules/
+    "rules": {
+      "@typescript-eslint/require-await": "off",
+      "@typescript-eslint/no-unnecessary-type-assertion": "warn",
+      "@typescript-eslint/array-type": ["warn", { "default": "array-simple" }]
+    },
+    "plugins": [
+      "@typescript-eslint" // will enable all implemented @typescript-eslint rules by default
+    ]
+  }
+]
+```
+
+## Editor Integration
+
+### VS Code
+
+Install the extension from the marketplace [rslint](https://marketplace.visualstudio.com/items?itemName=rstack.rslint)

README.md

@@ -32,10 +32,7 @@ Rslint is a fork of [tsgolint](https://github.com/typescript-eslint/tsgolint), b
 
 ## 🚀 Getting Started
 
-> [!NOTE]
-> Documentation and installation guides are coming soon. Rslint is currently in active development.
-
-Stay tuned for our first stable release with comprehensive documentation and migration guides.
+See [Guide](./GUIDE.md).
 
 ## 🦀 Rstack
 

packages/rslint/README.md

@@ -4,9 +4,9 @@
 
 ## Features
 
-- ⚡ **Ultra-fast**: 10x faster than ESLint through Go-powered parallel processing
+- ⚡ **Ultra-fast**: 10x+ faster than ESLint through Go-powered parallel processing
 - 🎯 **Typed linting first**: Enables typed linting by default for advanced semantic analysis
-- 🔧 **Easy migration**: Compatible with ESLint and TypeScript-ESLint configurations
+- 🔧 **Easy migration**: Compatible with ESLint and TypeScript-ESLint rule configurations
 - 🏗️ **Project-level analysis**: Performs cross-module analysis for better linting results
 - 📦 **Monorepo support**: First-class support for large-scale TypeScript monorepos
 - 🔋 **Batteries included**: Ships with all TypeScript-ESLint rules out of the box