<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)
* [Quick Docs](docs/features/quick-docs.md)
* [Structure View & Quick Nav](docs/features/structure-view.md)
* [WebGL/GLSL support](docs/features/webgl.md)
* [Code Folding](docs/features/code-folding.md)
* [Manage the Exposing List](docs/features/exposure.md)
* Plus the usual IDE stuff: code completion, go-to-declaration, spell-checking, etc.

Want to see it in action? This [10 minute video](https://www.youtube.com/watch?v=CC2TdNuZztI) demonstrates many of the features and how they work together.

_Note_: if you have [node](https://nodejs.org) installed using [nvm](https://github.com/nvm-sh/nvm), please see the
related information [here](docs/nvm.md).

## FAQ
See the elm-format [integration instructions](https://github.com/klazuka/intellij-elm/blob/master/docs/elm-format/setup.md).


# Attribution

This project heavily leverages the open-source work of other IntelliJ plugin developers:
- [ ] 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> Add new-project-setup directions to the readme

Fixes #102

<DFF> @@ -39,6 +39,24 @@ on its own, but you may need to manually attach it if the magic fails.
 See the elm-format [integration instructions](https://github.com/klazuka/intellij-elm/blob/master/docs/elm-format/setup.md).
 
 
+# Creating a new Elm project
+
+The plugin does not currently provide any new-project templates. Until that work is done, the easiest way to create a new
+Elm project is to do everything from the command line using the standard Elm tools. If you're using Elm 0.19, this means:
+
+1. create a new directory for your project
+1. run `elm init`
+1. open that directory in IntelliJ (or WebStorm, etc.)
+1. select the `src` directory in the IntelliJ project window
+1. select `File -> New -> Elm Module`, call the new file `Main`
+1. follow the prompt to setup the Elm toolchain by specifying the path to the directory which contains the Elm compiler
+1. follow the prompt to attach your project's `elm.json` file.
+1. you're all set to write some code
+
+Please note that the IntelliJ plugin does not install any of your project dependencies for you. It assumes that you have
+already installed them via the standard Elm command line tools.
+
+
 # Attribution
 
 This project heavily leverages the open-source work of other IntelliJ plugin developers:

Add new-project-setup directions to the readme