Skip to content

Commit 5831aff

Browse files
committed
Update the README to clarify pre-release status
1 parent b9bbef0 commit 5831aff

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
# elm-format
66

77
> `elm-format` is still in alpha. If you run into any problems, please [report them](https://github.com/avh4/elm-format/issues).
8+
>
9+
> **The format produced by elm-format may change significantly before the 1.0.0 release.** If this will cause problems for you, please refrain from using elm-format during the alpha- and beta-test periods.
810
911
`elm-format` formats [Elm](http://elm-lang.org) source code according to a standard set of rules. It is inspired by the popular [gofmt](https://blog.golang.org/go-fmt-your-code).
1012

@@ -28,7 +30,11 @@ elm-format --help # See other command line options
2830

2931
## Installation [![(latest version: 0.3.0-alpha)](https://img.shields.io/badge/version-0.3.0--alpha-blue.svg)](https://github.com/avh4/elm-format/releases/tag/0.3.0-alpha)
3032

31-
`elm-format` is still in alpha. You will need to download the version appropriate for your OS, unzip it, and place `elm-format` or `elm-format.exe` (windows) on your `PATH`.
33+
> `elm-format` is still in alpha. If you run into any problems, please [report them](https://github.com/avh4/elm-format/issues).
34+
>
35+
> **The format produced by elm-format may change significantly before the 1.0.0 release.** If this will cause problems for you, please refrain from using elm-format during the alpha- and beta-test periods.
36+
37+
You will need to download the version appropriate for your OS, unzip it, and place `elm-format` or `elm-format.exe` (windows) on your `PATH`. Simpler installation options will be available once there is a stable release of elm-format.
3238

3339
If the binary does not work for you, please [report details about your OS](https://github.com/avh4/elm-format/issues/new), or try [building from source](#building-from-source).
3440

0 commit comments

Comments
 (0)