How to use a modified Elm package in your app

There are a number of ways to use a modified Elm package in your app.

Include the package source code directly in your project. You can do this by:

Note: This approach also requires you to install the package's sub-dependency packages directly into your project, which you can solve by following the compiler's suggestions.

This helps automate approach (1) by the addition of an

file.

Check out the

for instructions.

Sometimes you don't want to publish another Elm package (i.e. when you've made a PR to the original package, but would still like to use your modifications immediately), so approaches (1) and (2) are suitable.

Otherwise, the final route is publishing your own package. Note: this cannot be undone! Packages published to the Elm package index are permanent.

Publishing a fork of a package makes it harder for everyone in the community to find high-quality packages. If you're looking for a library to resize images and you find

, then you can look at the documentation and see if it fits your needs. If you see both

and

with virtually the same documentation, then that gives users additional work to figure out and decide which package to use. We should try to avoid this as much as possible for everyone's sake.

The

command should guide you through what's needed.

You can also check out these user-guides: