From e3175024602e5fca19fc9bbb7ba455874d26c3c3 Mon Sep 17 00:00:00 2001
From: Lev Chelyadinov <leva181777@gmail.com>
Date: Sat, 8 Jun 2024 20:24:41 +0200
Subject: [PATCH] Bump versions and add README to Steiger

---
 packages/steiger-plugin-fsd/package.json |  2 +-
 packages/steiger/README.md               | 54 ++++++++++++++++++++++++
 packages/steiger/package.json            |  3 +-
 3 files changed, 57 insertions(+), 2 deletions(-)
 create mode 100644 packages/steiger/README.md

diff --git a/packages/steiger-plugin-fsd/package.json b/packages/steiger-plugin-fsd/package.json
index c5ad5ff..a7b35ba 100644
--- a/packages/steiger-plugin-fsd/package.json
+++ b/packages/steiger-plugin-fsd/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@feature-sliced/steiger-plugin",
   "description": "A set of rules to verify correct usage of Feature-Sliced Design",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "scripts": {
     "lint": "eslint .",
     "format": "prettier --write . --cache",
diff --git a/packages/steiger/README.md b/packages/steiger/README.md
new file mode 100644
index 0000000..916a72d
--- /dev/null
+++ b/packages/steiger/README.md
@@ -0,0 +1,54 @@
+# Steiger
+
+Universal file structure and project architecture linter.
+
+> [!NOTE]
+> The project is in beta and in active development. Some APIs may change.
+
+# Features
+
+- Built-in set of rules to validate adherence to [Feature-Sliced Design](https://feature-sliced.design/)
+- Watch mode
+- Rule configurability
+
+# Installation
+
+```bash
+npm i -D steiger
+```
+
+# Usage
+
+```bash
+steiger ./src
+```
+
+To run in watch mode, add `-w`/`--watch` to the command:
+
+```bash
+steiger ./src --watch
+```
+
+# Configuration
+
+Steiger is configurable via `cosmiconfig`. That means that you can create a `steiger.config.ts` or `steiger.config.js` file in the root of your project to configure the rules. Import `{ defineConfig } from "steiger"` to get autocompletion.
+
+```ts
+import { defineConfig } from 'steiger'
+
+export default defineConfig({
+  rules: {
+    'no-public-api': 'off',
+  },
+})
+```
+
+# Contribution
+
+Feel free to report an issue or open a discussion. Ensure you read our [Code of Conduct](CODE_OF_CONDUCT.md) first though :)
+
+To get started with the codebase, see our [Contributing guide](CONTRIBUTING.md).
+
+# Legal info
+
+Project licensed under [MIT License](LICENSE.md). [Here's what it means](https://choosealicense.com/licenses/mit/)
diff --git a/packages/steiger/package.json b/packages/steiger/package.json
index ae47208..51d6924 100644
--- a/packages/steiger/package.json
+++ b/packages/steiger/package.json
@@ -36,7 +36,8 @@
   },
   "files": [
     "dist",
-    "src"
+    "src",
+    "README.md"
   ],
   "dependencies": {
     "@feature-sliced/filesystem": "^2.2.3",