eslint-plugin: add readme

Signed-off-by: vince-fugnitto <[email protected]>

dev-packages/eslint-plugin/README.md

@@ -0,0 +1,44 @@
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - ESLINT PLUGIN</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+The `@theia/eslint-plugin` contributes rules useful for Eclipse Theia development.
+The plugin helps identify problems during development through static analysis including code quality, potential issues and code smells.
+
+## Rules
+
+#### `runtime-import-check`:
+
+The rule prevents imports from folders meant for incompatible runtimes.
+The check enforces the [code organization guidelines](https://github.com/eclipse-theia/theia/wiki/Code-Organization) of the framework and guards against invalid imports which may cause unforeseen issues downstream.
+
+#### `shared-dependencies`:
+
+The rule prevents the following:
+- prevents the implicit use of a shared dependency from `@theia/core`.
+- prevents extensions from depending on a shared dependency without re-using it from `@theia/core`.
+
+## Additional Information
+
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+-   [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+-   [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia

dev-packages/eslint-plugin/index.js

@@ -17,6 +17,6 @@
 
 /** @type {{[ruleId: string]: import('eslint').Rule.RuleModule}} */
 exports.rules = {
-    "shared-dependencies": require('./rules/shared-dependencies'),
-    "runtime-import-check": require('./rules/runtime-import-check')
+    "runtime-import-check": require('./rules/runtime-import-check'),
+    "shared-dependencies": require('./rules/shared-dependencies')
 };