Add README with development, publish instructions

- Add eslint, fix paths in package.json
- Move webpack config to subdirectory

Author: Per Nilsson

.eslintrc.json

@@ -0,0 +1,50 @@
+{
+    "env": {
+        "node": false,
+        "browser": true,
+        "es6": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module",
+        "ecmaFeatures": {
+            "jsx": true
+        }
+    },
+    "plugins": [
+        "import",
+        "react"
+    ],
+    "rules": {
+        "react/jsx-uses-vars": 2,
+        "react/jsx-uses-react": 2,
+        "react/react-in-jsx-scope": 2,
+        "import/imports-first": 2,
+        "import/no-unresolved": 2,
+        "import/named": 2,
+        "import/default": 2,
+        "import/namespace": 2,
+        "import/export": 2,
+        "import/no-named-as-default": 2,
+        "import/no-named-as-default-member": 2,
+        "import/no-deprecated": 2,
+        "import/no-extraneous-dependencies": 2,
+        "import/no-mutable-exports": 2,
+        "import/no-commonjs": 2,
+        "import/no-amd": 2,
+        "import/no-nodejs-modules": 2,
+        "import/imports-first": 2,
+        "import/no-duplicates": 2,
+        "import/no-namespace": 2,
+        "import/extensions": 2,
+        "import/order": 2,
+        "import/newline-after-import": 2,
+        "import/prefer-default-export": 2
+    },
+    "settings": {
+        "react": {
+            "version": "15.0"
+        }
+    }
+}

README.md

@@ -0,0 +1,43 @@
+# Dash Components Core
+
+This package provides the core React component suite for [Dash2][].
+
+## Development
+
+We don't yet have a dev server with demo capabilities in this repo. The best way
+to test your components is by linking into `dash2` and testing them from there.
+
+1. Prepare module by linking and watching for changes
+
+        # Symlink module
+        $ npm link
+
+        # Transpile components to `lib/` and watch for changes
+        $ npm start
+
+2. Link module into `dash2` project
+
+        # In the `dash2/renderer` project directory:
+        $ npm link dash-components-core
+
+Now you should be able to restart the webpack process (in `dash2/renderer`:
+`ctrl-c`, `npm start`), after which webpack will automatically pick up new
+changes to the component suite.
+
+## Publishing
+
+Ask @coopy or @chriddyp to be added to the [NPM package authors][].
+
+```sh
+# Bump the package version
+$ npm version major|minor|patch
+
+# Push branch and tags to repo
+$ git push --follow-tags
+
+# Publish to NPM (will run tests as a pre-publish step)
+$ npm publish
+```
+
+[Dash2]: https://github.com/plotly/dash2
+[NPM package authors]: https://www.npmjs.com/package/dash-components-core/access

config/.eslintrc.json

@@ -1,3 +1,5 @@
 {
-    "extends": "../../config/eslint/eslintrc-node.json"
+    // This is a little crazy - referencing `./` makes eslint look in the
+    // `node_modules` directory. This is a workaround for now:
+    "extends": "../config/eslint/eslintrc-node.json"
 }

config/eslint/eslintrc-node.json

@@ -0,0 +1,13 @@
+{
+    "env": {
+        "node": true
+    },
+    "extends": "eslint:recommended",
+    "plugins": [
+        "import"
+    ],
+    "rules": {
+        "import/no-commonjs": 0,
+        "import/no-nodejs-modules": 0
+    }
+}

config/webpack.config.dev.js renamed to config/webpack/webpack.config.dev.js

@@ -2,15 +2,20 @@
   "name": "dash-components-core",
   "version": "0.0.3",
   "description": "Core component suite for Dash2",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/plotly/dash-components-core.git"
+  },
   "main": "lib/basic/index.js",
   "scripts": {
     "clean-lib": "mkdir -p lib && rm -rf lib/*",
     "transpile-dev": "npm run clean-lib && npm run extract-metadata && babel --source-root ./src/ -d lib/ src/",
     "transpile-dev-watch": "npm run clean-lib && npm run extract-metadata && babel --watch --source-root ./src/ -d lib/ src/",
-    "build-dev": "webpack --config=config/webpack.config.dev.js",
+    "build-dev": "webpack --config=config/webpack/webpack.config.dev.js",
     "extract-metadata": "mkdir -p lib && react-docgen --pretty -o lib/metadata.json src/basic/components",
-    "dev": "webpack-dev-server --config=config/webpack.config.dev.js",
-    "lint": "eslint --quiet --fix --ignore-path ../.gitignore .",
+    "dev": "webpack-dev-server --config=config/webpack/webpack.config.dev.js",
+    "lint": "eslint --quiet --fix --ignore-path .gitignore .",
+    "prepublish": "npm test",
     "start": "npm run transpile-dev-watch",
     "test": "npm run lint"
   },