diff --git a/npm-packages/eslint-config-meteor/README.md b/npm-packages/eslint-config-meteor/README.md deleted file mode 100644 index 27c8ba5595..0000000000 --- a/npm-packages/eslint-config-meteor/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# eslint-config-meteor - -This is an [ESLint](https://eslint.org) configuration for [Meteor](https://www.meteor.com) apps which implements the recommendations from the [Meteor Guide](https://guide.meteor.com/)'s section on [Code style](https://guide.meteor.com/code-style.html#eslint). - -# Usage - -## Install - -Install by running: - -```sh -meteor npm install --save-dev @meteorjs/eslint-config-meteor -``` - -> Using `meteor npm` is optional for this package, but best-practice for Meteor projects in general. - -### Peer Dependencies - -This package has several [peer dependencies](https://nodejs.org/en/blog/npm/peer-dependencies/) listed in its [`package.json`'s `peerDependencies` section](package.json). Warnings will be encountered during the installation step above if the project doesn't already use these modules. - -The peer dependencies can be installed manually by following the `package.json` specification and using `meteor npm install --save-dev ` or, alternatively, using an automated tool: - -```sh -$ # Install `install-peerdeps` within the current Meteor tool version. -$ meteor npm install --global install-peerdeps -$ # Run the newly installed `install-peerdeps` to install this package and its dependencies. -$ meteor install-peerdeps --dev @meteorjs/eslint-config-meteor -``` - -## Configure - -Add the following to the project's `package.json`: - -```json -"eslintConfig": { - "extends": "@meteorjs/eslint-config-meteor" -} -``` diff --git a/npm-packages/eslint-config-meteor/Readme.md b/npm-packages/eslint-config-meteor/Readme.md deleted file mode 100644 index ec46004063..0000000000 --- a/npm-packages/eslint-config-meteor/Readme.md +++ /dev/null @@ -1 +0,0 @@ -# Readme \ No newline at end of file