Merge pull request #33 from campuspress/new/refactor-inline-resources

Divi Accessibility 2.0.0

Author: alexstine

.eslintrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es6": true,
+		"jquery": true
+    },
+    "extends": "eslint:recommended",
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+	"ignorePatterns": [ "**/*.min.js" ],
+    "parserOptions": {
+        "ecmaVersion": 2018
+    },
+    "rules": {
+		"no-extra-semi": 0
+    }
+};

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 node_modules
+*.zip

README.md

@@ -18,6 +18,27 @@ A WordPress plugin that improves Divi accessibility in accordance with WCAG 2.0
 + Fix duplicate menu IDs
 + Tota11y integration
 
+
+Development
+-----------
+
+The working js/css snippets are, by default, included minified. They can be forcefully included in their full expanded state by enabling the developer mode option in plugin settings. They will also respect the WP core `SCRIPTS_DEBUG` define value.
+
+To check js/css snippets for any errors, run the dedicated `npm run lint` script.
+
+To build the minified versions of the js/css snippets, run `npm run build` script.
+
+While working on snippets, it may be beneficial to have them automatically re-built on file change. This is what the `npm run watch` script does.
+
+To package an intermediate (throwaway) plugin zip archive for testing, use the `npm run package` script.
+
+To actually build a releaseable package, use the `npm run release [-y] [--version=X.X.X]`. This will lint everything, build the languages catalog file, and normalize version numbers across files (main php file, package.json and readme.txt). It will then rebuild everything and produce a versioned zip archive.
+
+The release version can either be supplied via a command line parameter (`--version=x.x.x`), or it will be inferred from the files that might be containing the version number (main php file and package.json). If the version number is being inferred, the highest one is the version that will be used.
+
+If the final resolved release version is different than what's in package.json and/or main php file, they can optionally be updated to match. By default, the prerelease script will ask for user input whether to do this or not. This can be prevented using the command line flag `-y` - if this command line flag is set, the files will always be updated if necessary without any further input.
+
+
 ## Resources
 
 + [Web Content Accessibility Guidelines (WCAG) 2.0](https://www.w3.org/TR/WCAG20/)