Skip to content

Commit 9206387

Browse files
committed
docs($docs): Added docs for the new alias
1 parent ece9736 commit 9206387

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

template/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ You can find the most recent version of this guide [here](https://github.com/hal
1111
- [Available scripts](#available-scripts)
1212
- [elm-app build](#elm-app-build)
1313
- [elm-app start](#elm-app-start)
14+
- [elm-app install](#elm-app-install)
1415
- [elm-app test](#elm-app-test)
1516
- [elm-app eject](#elm-app-eject)
1617
- [elm-app <elm-platform-comand>](#elm-app-elm-platform-comand)
@@ -41,9 +42,11 @@ You are very welcome with any [feedback](https://github.com/halfzebra/create-elm
4142
## Installing Elm packages
4243

4344
```sh
44-
elm-app package install <package-name>
45+
elm-app install <package-name>
4546
```
4647

48+
Other `elm-package` commands are also [available.](#package)
49+
4750
## Installing JavaScript packages
4851

4952
To use JavaScript packages from npm, you'll need to add a `package.json`, install the dependencies, and you're ready to go.
@@ -102,6 +105,10 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
102105
The page will reload if you make edits.
103106
You will also see any lint errors in the console.
104107

108+
### `elm-app install`
109+
110+
An alias for [`elm-app package install`](#package)
111+
105112
### `elm-app test`
106113
Run tests with [node-test-runner](https://github.com/rtfeldman/node-test-runner/tree/master)
107114

@@ -111,6 +118,7 @@ elm-app test --watch
111118
```
112119

113120
### `elm-app eject`
121+
114122
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
115123

116124
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time.
@@ -120,20 +128,25 @@ Instead, it will copy all the configuration files and the transitive dependencie
120128
You don’t have to use 'eject' The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However, we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
121129

122130
### `elm-app <elm-platform-comand>`
131+
123132
Create Elm App does not rely on the global installation of Elm Platform, but you still can use it's local Elm Platform to access default command line tools:
124133

125134
#### `package`
135+
126136
Alias for [elm-package](http://guide.elm-lang.org/get_started.html#elm-package)
127137

128138
Use it for installing Elm packages from [package.elm-lang.org](http://package.elm-lang.org/)
129139

130140
#### `repl`
141+
131142
Alias for [elm-repl](http://guide.elm-lang.org/get_started.html#elm-repl)
132143

133144
#### `make`
145+
134146
Alias for [elm-make](http://guide.elm-lang.org/get_started.html#elm-make)
135147

136148
#### `reactor`
149+
137150
Alias for [elm-reactor](http://guide.elm-lang.org/get_started.html#elm-reactor)
138151

139152

0 commit comments

Comments
 (0)