wip

packages/eslint-plugin/.gitignore

@@ -0,0 +1 @@
+package.tgz

packages/eslint-plugin/.npmignore

@@ -1 +1,2 @@
 rules/*.test.js
+package.tgz

packages/eslint-plugin/README.md

@@ -5,7 +5,7 @@ This package contains an eslint plugin that enforces some default rules for usin
 ## Setup
 
 1. Install `@elastic/eslint-plugin-eui` as a dev dependency.
-2. Extend `plugin:@elastic/eui/recommended` in your eslint config.
+2. Extend `plugin:@elastic/eui/recommended` in your ESLint config.
 
 ## Rules
 
@@ -23,6 +23,15 @@ We don't use `no-restricted-imports` because ESLint doesn't allow multiple error
 
 All deprecations still must follow our [deprecation process](../../wiki/eui-team-processes/deprecations.md).
 
+## Testing
+
+### Against an existing package
+
+To test the local changes to the plugin, you must:
+
+1. Run `yarn pack` in the directory.
+3. In your project's `package.json`, point `@elastic/eslint-plugin-eui` to `file:/path/to/eslint-plugin-custom-rules-1.0.0.tgz`.
+
 ## Publishing
 
 This package is published separately from the rest of EUI, as required by eslint. The code is not transpiled, so make sure to use `require()` statements rather than `import`, and once the code is updated run: