diff --git a/README.md b/README.md index d8acdced00f105f8feefcc1ebb21b8514be5c948..299ce72010540c9b6bd7b9730e05c161bc6e523b 100644 --- a/README.md +++ b/README.md @@ -173,40 +173,6 @@ $HOME/.local/share/crush/crush.json %LOCALAPPDATA%\crush\crush.json ``` -### Attribution Settings - -By default, Crush adds attribution information to Git commits and pull requests -it creates. You can customize this behavior with the `attribution` option: - -```json -{ - "$schema": "https://charm.land/crush.json", - "options": { - "attribution": { - "co_authored_by": true, - "generated_with": true - } - } -} -``` - -- `co_authored_by`: When true (default), adds `Co-Authored-By: Crush ` to commit messages -- `generated_with`: When true (default), adds `💘 Generated with Crush` line to commit messages and PR descriptions - -To disable all attribution, set both options to false: - -```json -{ - "$schema": "https://charm.land/crush.json", - "options": { - "attribution": { - "co_authored_by": false, - "generated_with": false - } - } -} -``` - ### LSPs Crush can use LSPs for additional context to help inform its decisions, just @@ -304,6 +270,26 @@ permissions. Use this with care. You can also skip all permission prompts entirely by running Crush with the `--yolo` flag. Be very, very careful with this feature. +### Attribution Settings + +By default, Crush adds attribution information to Git commits and pull requests +it creates. You can customize this behavior with the `attribution` option: + +```json +{ + "$schema": "https://charm.land/crush.json", + "options": { + "attribution": { + "co_authored_by": true, + "generated_with": true + } + } +} +``` + +- `co_authored_by`: When true (default), adds `Co-Authored-By: Crush ` to commit messages +- `generated_with`: When true (default), adds `💘 Generated with Crush` line to commit messages and PR descriptions + ### Local Models Local models can also be configured via OpenAI-compatible API. Here are two common examples: