ash-project/igniter
1
0
Fork 0
mirror of https://github.com/ash-project/igniter.git synced 2024-09-19 13:02:51 +12:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: update readme

Browse source
This commit is contained in:
Zach Daniel 2024-06-12 20:54:44 -04:00
parent 515cca06ac
commit 80272c887b
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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 <package>`, 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: