<NME> README.md
<BEF> # Elm Plugin for IntelliJ IDEs (WebStorm, IDEA, PyCharm, etc.)

## Install

You can install the plugin from within the JetBrains IDE by going to **Settings -> Plugins** and then searching for "Elm". After installing the plugin, restart the IDE and then [open your existing Elm project](docs/existing-project.md) or [create a new project](docs/new-project.md).


## Highlighted Features

- [Live Error Checking](docs/features/live-error-checking.md)
- [Generate JSON Decoders & Encoders](docs/features/generate-function-json.md)
- [Rename refactoring](docs/features/rename-refactoring.md)
- [Lamdera support](docs/features/lamdera.md)
- [elm-review support](docs/features/elm-review.md)


## Additional Features 

* [Type Inference](docs/features/type-inference.md)
* [Find Usages](docs/features/find-usages.md)
* [Run Tests](docs/features/elm-test.md) (elm-test)
* [Reformat File](docs/features/elm-format.md) (elm-format)
* [Cleanup unused imports](docs/features/unused-imports.md)
* [Detect unused code](docs/features/unused-code.md)
* [Add Imports](docs/features/add-imports.md)
* hand-written Psi classes


# Development

There is still a lot of work left to do, but PRs are welcome. To build the plugin you will need to do the following:

## FAQ

- Is this free?
    - Yes, the plugin itself is free and it works with the free version of IntelliJ.
- What versions of IntelliJ does this work with?
    - IntelliJ IDEA Ultimate

This project heavily leverages the open-source work of other IntelliJ plugin developers:

* Lexer and Parser from Kamil Durkiewicz's [elm-intellij-plugin](https://github.com/durkiewicz/elm-plugin).
* Offside-rule Lexer from Alexander Kiel's [idea-haskell](https://github.com/alexanderkiel/idea-haskell) plugin.
* Code organization and testing utils based on the [Rust plugin](https://github.com/intellij-rust/intellij-rust) for IntelliJ. 

Thank you Kamil, Alexander, and the Rust plugin developers.


# Donation

If this plugin improves your Elm development experience, and you want to give back, please consider making a [donation](http://www.brahmrishiyoga.org/donate) (tax-deductible in the US) to the [Narmada Vidya Peeth school](http://www.brahmrishiyoga.org/jabalpur_school/photo_gallery) in Jabalpur, India. This school provides a completely free education to 550 boys and girls, from ages 5 to 17. I have visited the school twice in the past 6 years, and I can vouch for the worthiness of the cause.

Alternatively consider making donations to your favorite open-source developers and projects.
- [ ] Verify the [pluginGroup](/gradle.properties), [plugin ID](/src/main/resources/META-INF/plugin.xml) and [sources package](/src/main/kotlin).
- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html).
- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.
- [ ] Set the Plugin ID in the above README badges.
- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html).
- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.

<!-- Plugin description -->
Elm & Lamdera Plugin
<!-- Plugin description end -->

## Installation

- Using IDE built-in plugin system:

  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "Elm"</kbd> >
  <kbd>Install Plugin</kbd>

- Manually:

  Download the [latest release](https://github.com/klazuka/intellij-elm/releases/latest) and install it manually using
  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>


---
Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template

<MSG> More elm-format instructions

<DFF> @@ -26,6 +26,11 @@ Prior to creating this plugin, I used to contribute to a very good [Elm plugin](
 * hand-written Psi classes
 
 
+# Integrating with elm-format
+
+See the elm-format [integration instructions](https://github.com/klazuka/intellij-elm/blob/master/docs/elm-format/setup.md).
+
+
 # Development
 
 There is still a lot of work left to do, but PRs are welcome. To build the plugin you will need to do the following:
@@ -39,15 +44,15 @@ There is still a lot of work left to do, but PRs are welcome. To build the plugi
 
 This project heavily leverages the open-source work of other IntelliJ plugin developers:
 
-* Lexer and Parser from Kamil Durkiewicz's [elm-intellij-plugin](https://github.com/durkiewicz/elm-plugin).
-* Offside-rule Lexer from Alexander Kiel's [idea-haskell](https://github.com/alexanderkiel/idea-haskell) plugin.
 * Code organization and testing utils based on the [Rust plugin](https://github.com/intellij-rust/intellij-rust) for IntelliJ. 
+* Lexer and Parser originally from Kamil Durkiewicz's [elm-intellij-plugin](https://github.com/durkiewicz/elm-plugin).
+* Offside-rule Lexer originally based on code from Alexander Kiel's [idea-haskell](https://github.com/alexanderkiel/idea-haskell) plugin.
 
 Thank you Kamil, Alexander, and the Rust plugin developers.
 
 
 # Donation
 
-If this plugin improves your Elm development experience, and you want to give back, please consider making a [donation](http://www.brahmrishiyoga.org/donate) (tax-deductible in the US) to the [Narmada Vidya Peeth school](http://www.brahmrishiyoga.org/jabalpur_school/photo_gallery) in Jabalpur, India. This school provides a completely free education to 550 boys and girls, from ages 5 to 17. I have visited the school twice in the past 6 years, and I can vouch for the worthiness of the cause.
+If this plugin improves your Elm development experience, and you want to give back, please consider making a [donation](http://www.brahmrishiyoga.org/donate) (tax-deductible in the US) to the [Narmada Vidya Peeth school](http://www.brahmrishiyoga.org/jabalpur_school/photo_gallery) in Jabalpur, India. This school provides a completely free education to 550 boys and girls, from ages 5 to 17. I have visited the school three times since 2012, and I can vouch for the worthiness of the cause.
 
 Alternatively consider making donations to your favorite open-source developers and projects.

More elm-format instructions