Merge pull request #31 from alleyinteractive/feature/NYP-13213/add-core-framework

NYP-13213 - Add core framework, drop IE support

Author: Steven Slack

.babelrc

@@ -1,12 +1,4 @@
 {
-  "plugins": [
-    "transform-es2015-parameters",
-    ["@babel/transform-runtime", {
-      "regenerator": true
-    }],
-    "@babel/plugin-transform-spread"
-  ],
-  "presets": [
-    ["@babel/preset-env"]
-  ]
+  "plugins": ["@babel/plugin-transform-runtime"],
+  "presets": ["@babel/preset-env"]
 }

.eslintrc

@@ -0,0 +1,26 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true
+  },
+  "extends": ["airbnb"],
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "globalReturn": true,
+      "impliedStrict": true
+    },
+    "sourceType": "module"
+  },
+  "rules": {
+    "max-len": [
+      "error", { "ignoreComments": true }
+    ]
+  },
+  "settings": {
+    "react": {
+      "version": "999.999.999"
+    }
+  }
+}

.eslintrc.json

@@ -1,3 +1,4 @@
 /lib/
+/core/
 /node_modules/
 *.sublime-*

.gitignore

@@ -1,4 +1,4 @@
-# Component Starter Framework
+# Component Framework
 
 A framework for attaching an ES6 class to a DOM element or collection of DOM elements, making it easier to organize the DOM interactions on your website.
 
@@ -16,6 +16,38 @@ The library will ...
 
 This results in distinct (and encapsulated) functionality for each DOM element.
 
+## Getting Started
+
+Install the js-component-framework and all the plugins:
+```bash
+npm install js-component-framework
+```
+Below is a basic set up for using the component framework without the included Aria plugins:
+
+```javascript
+// Import only the core component framework library.
+import { Component } from 'js-component-framework/core';
+
+/**
+ * Custom component which extends the base component class.
+ */
+class MyComponent extends Component {
+
+  /**
+   * Start the component
+   */
+  constructor(config) {
+    super(config);
+  }
+}
+```
+
+If you also want to use the entire framework with the bundled Aria plugins use the default import:
+```js
+import { Component, plugins } from 'js-component-framework';
+```
+
+
 ## Best practices for creating components
 
 ### Create one directory per component

README.md

@@ -17,7 +17,7 @@ export default class Header extends Component {
     // Other Options
     this.offset = this.options.offset;
 
-    // Initalizations
+    // Initializations
     this.init();
   }