Skip to content

Commit c6f2f03

Browse files
committed
chore: work on docs
1 parent eaf144d commit c6f2f03

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

lib/mix/tasks/usage_rules.install.ex

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,24 @@ if Code.ensure_loaded?(Igniter) do
4646
def igniter(igniter) do
4747
igniter
4848
|> Igniter.add_notice("""
49-
`usage_rules` is installed!
49+
Usage Rules: Sync usage rules for the packages you use.
5050
51-
Example sync commands:
52-
- `mix usage_rules.sync AGENTS.md --all --link-to-folder rules --inline usage_rules:all`
53-
- `mix usage_rules.sync RULES.md --all`
51+
Suggested starting point to sync all usage rules:
5452
55-
For more info and examples: `mix help usage_rules.sync`
56-
""")
53+
mix usage_rules.sync AGENTS.md --all \
54+
--inline usage_rules:all \
55+
--link-to-folder deps
56+
57+
Or sync only a specific set, copying their rules to a
58+
specific folder
59+
60+
mix usage_rules.sync AGENTS.md \
61+
ash ash_postgres \
62+
--link-to-folder rules
63+
64+
65+
For more ineo and examples: `mix help usage_rules.sync`
66+
""")
5767
end
5868
end
5969
else

0 commit comments

Comments
 (0)