feat: initial release

.eslintrc.json

@@ -3,44 +3,12 @@
     "es6": true,
     "node": true
   },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaFeatures": {
-      "impliedStrict": true
-    },
-    "ecmaVersion": 6,
-    "project": "./tsconfig.json",
-    "sourceType": "module",
-    "tsconfigRootDir": "."
-  },
-  "plugins": ["@typescript-eslint", "prettier"],
-  "extends": [
-    "eslint:recommended",
-    "xo",
-    "prettier",
-    "plugin:@typescript-eslint/recommended"
-  ],
+  "plugins": ["prettier"],
+  "extends": ["eslint:recommended", "xo", "prettier"],
   "rules": {
-    // Possible Errors
     "no-async-promise-executor": "error",
     "no-await-in-loop": "error",
     "no-misleading-character-class": "error",
-    "no-template-curly-in-string": "error",
-
-    // TypeScript-ESLint (Prettier)
-    "@typescript-eslint/member-delimiter-style": "off",
-
-    // TypeScript-ESLint
-    "@typescript-eslint/explicit-function-return-type": "off",
-    "@typescript-eslint/indent": "off",
-    "@typescript-eslint/no-explicit-any": "error",
-    "@typescript-eslint/no-object-literal-type-assertion": "off",
-    "@typescript-eslint/no-this-alias": [
-      "error",
-      {
-        "allowDestructuring": true
-      }
-    ],
-    "@typescript-eslint/no-use-before-define": "off"
+    "no-template-curly-in-string": "error"
   }
 }

.markdownlint.json

@@ -1,4 +1,5 @@
 {
+  "commands-show-output": false,
   "list-marker-space": {
     "ol_multi": 2,
     "ol_single": 2,

.vscode/tasks.json

@@ -11,16 +11,6 @@
       "script": "lint",
       "problemMatcher": ["$eslint-stylish"]
     },
-    {
-      "type": "npm",
-      "script": "check-types",
-      "problemMatcher": ["$tsc"]
-    },
-    {
-      "type": "npm",
-      "script": "start",
-      "problemMatcher": ["$tsc-watch"]
-    },
     {
       "type": "npm",
       "script": "test",

README.md

@@ -1,5 +1,38 @@
-# private-node-starter
+# craco-linaria
 
-[![Travis Build Status](https://travis-ci.com/jedmao/private-node-starter.svg?branch=master)](https://travis-ci.com/jedmao/private-node-starter)
-[![codecov](https://codecov.io/gh/jedmao/private-node-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/jedmao/private-node-starter)
+[![Travis Build Status](https://travis-ci.com/jedmao/craco-linaria.svg?branch=master)](https://travis-ci.com/jedmao/craco-linaria)
+[![codecov](https://codecov.io/gh/jedmao/craco-linaria/branch/master/graph/badge.svg)](https://codecov.io/gh/jedmao/craco-linaria)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+
+A [craco](https://www.npmjs.com/package/@craco/craco) plugin to use [Linaria][]
+zero-runtime CSS in JS library in a create react app.
+
+## Installation
+
+First, follow craco's
+[installation instructions](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#installation).
+
+Then, install `craco-linaria`:
+
+```bash
+$ npm install --save craco-linaria
+```
+
+## Usage
+
+```js
+/* craco.config.js */
+const CracoLinariaPlugin = require('craco-linaria')
+
+module.exports = {
+  plugins: [{ plugin: CracoLinariaPlugin }],
+}
+```
+
+## Git Ignore
+
+This plugin stores [Linaria][] cache in `src/.linaria_cache`, so you might want
+to add that path to your [`.gitignore`](https://git-scm.com/docs/gitignore)
+file.
+
+[linaria]: https://linaria.now.sh/