diff --git a/README.md b/README.md index 105fd88..fa91693 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,14 @@ Igniter is a code generation and project patching framework. +For library authors, this is a tool kit for writing smarter generators that can semantically modify existing files, and all sorts of useful tools for doing so. + +For end-users, this means `mix igniter.install `, which will _add it to your mix.exs automatically_ and then run that library's installer if it has one. Even when libraries don't have an installer, or use igniter, this behavior makes it useful to keep around. + +## State of the project + +This project is in early beta. There is _so much to add_! There are lots of DX/UX things to improve, but it does already provide some great utility. Contributions welcome! + ## Installation Igniter can be added to an existing elixir project by adding it to your dependencies: