chore: README

ijxy · May 23, 2024 · fe8693a · fe8693a
1 parent 297554b
commit fe8693a
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+[npm]: https://www.npmjs.com/package/eslint-config-tip
+
+[![npm verison](https://img.shields.io/npm/v/eslint-config-tip)][npm]
+[![npm bundle size](https://img.shields.io/bundlephobia/min/eslint-config-tip)][npm]
+[![npm downloads](https://img.shields.io/npm/dm/eslint-config-tip)][npm]
+
+# eslint-config-tip
+
+An opinionated ESLint config that combines rules for **t**ypescript, **i**mports and **p**rettier.
+
+
+## Installation
+
+```
+npm install -D eslint eslint-config-tip
+```
+
+## Usage
+
+```ts
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  root: true,
+  extends: ["tip"],
+};
+```