git.iko.soy/crush
on main help sign in
docs(readme): tidy attribution section
38468a3Christian Rocha
README.md+20−34
compare with main
unifiedsplit
@@ -173,40 +173,6 @@ $HOME/.local/share/crush/crush.json
173%LOCALAPPDATA%\crush\crush.json
173%LOCALAPPDATA%\crush\crush.json
174```
174```
175
175
176−### Attribution Settings
177−
178−By default, Crush adds attribution information to Git commits and pull requests
179−it creates. You can customize this behavior with the `attribution` option:
180−
181−```json
182−{
183− "$schema": "https://charm.land/crush.json",
184− "options": {
185− "attribution": {
186− "co_authored_by": true,
187− "generated_with": true
188− }
189− }
190−}
191−```
192−
193−- `co_authored_by`: When true (default), adds `Co-Authored-By: Crush <crush@charm.land>` to commit messages
194−- `generated_with`: When true (default), adds `💘 Generated with Crush` line to commit messages and PR descriptions
195−
196−To disable all attribution, set both options to false:
197−
198−```json
199−{
200− "$schema": "https://charm.land/crush.json",
201− "options": {
202− "attribution": {
203− "co_authored_by": false,
204− "generated_with": false
205− }
206− }
207−}
208−```
209−
210### LSPs
176### LSPs
211
177
212Crush can use LSPs for additional context to help inform its decisions, just
178Crush can use LSPs for additional context to help inform its decisions, just
@@ -304,6 +270,26 @@ permissions. Use this with care.
304You can also skip all permission prompts entirely by running Crush with the
270You can also skip all permission prompts entirely by running Crush with the
305`--yolo` flag. Be very, very careful with this feature.
271`--yolo` flag. Be very, very careful with this feature.
306
272
273+### Attribution Settings
274+
275+By default, Crush adds attribution information to Git commits and pull requests
276+it creates. You can customize this behavior with the `attribution` option:
277+
278+```json
279+{
280+ "$schema": "https://charm.land/crush.json",
281+ "options": {
282+ "attribution": {
283+ "co_authored_by": true,
284+ "generated_with": true
285+ }
286+ }
287+}
288+```
289+
290+- `co_authored_by`: When true (default), adds `Co-Authored-By: Crush <crush@charm.land>` to commit messages
291+- `generated_with`: When true (default), adds `💘 Generated with Crush` line to commit messages and PR descriptions
292+
307### Local Models
293### Local Models
308
294
309Local models can also be configured via OpenAI-compatible API. Here are two common examples:
295Local models can also be configured via OpenAI-compatible API. Here are two common examples: