Add README

Author: LukasKalbertodt

README.md

@@ -0,0 +1,28 @@
+# Opencast Shared ESLint config (for TS + React)
+
+ESLint configuration used by many Opencast-related frontend projects.
+This configuration contains rules for TypeScript and React, so it's only useful for projects using both of those.
+
+## Usage
+
+Run:
+
+```
+npm install --save-dev @opencast/eslint-config-ts-react
+```
+
+And add this to your ESLint config (e.g. `.eslintrc.js`):
+
+```javascript
+{
+    extends: ["@opencast/eslint-config-ts-react"],
+    // ...
+}
+```
+
+Also make sure you already have `eslint` and all other [`peerDependencies` of this configuration](./package.json) in your `package.json`.
+
+
+# License
+
+Licensed as [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/).