Docs: Update Getting Started w/ Readme installation instructions #6823
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@kaicataldo, thanks for your PR! By analyzing the annotation information on this pull request, we identified @nzakas and @peterood to be potential reviewers |
|
LGTM |
|
|
||
| **Note:** `eslint --init` is intended for setting up and configuring ESLint on a per-project basis and will perform a local installation of ESLint and its plugins in the directory in which it is run. If you prefer using a global installation of ESLint, any plugins used in your configuration must also be installed globally. | ||
|
|
||
| ## Configuration | ||
|
|
||
| **Note:** If you are coming from a version before 1.0.0 please see the [migration guide](http://eslint.org/docs/user-guide/migrating-to-1.0.0). | ||
|
|
||
| After running `eslint --init`, you'll have a `.eslintrc.*` file in your directory. In it, you'll see some rules configured like this: | ||
| After running `eslint --init`, you'll have a `.eslintrc` file in your directory. In it, you'll see some rules configured like this: |
There was a problem hiding this comment.
Updated to match the Readme
|
Lgtm |
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What issue does this pull request address?
Referencing the discussion at #6732
What changes did you make? (Give an overview)
Updated the Getting Started documentation with the changes made to the Readme in 66de9d8