diff --git a/README.md b/README.md index b4f8929..cc1c616 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@ Your Refactoring Alarm ๐Ÿ”” Code Limit is a tool for developers with one goal: _it tells the developer when itโ€™s time to refactor_. -Keep your code maintainable and start using Code Limit today! +Check out the [documentation](https://codelimit-docs.vercel.app) and start +using Code Limit today to keep your code maintainable. # Quickstart diff --git a/docs/configuration.md b/docs/configuration.md index 0d7c7ec..5e036bd 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,12 +1,12 @@ # Configuration -## Ignoring functions +## Excluding functions Functions can be excluded from analysis by putting a `# nocl` comment on the -line above the start of the funtion, or any line of the function header. +line above the start of the function, or at any line of the function header. For example, to ignore a function with a `# nocl` comment above the start of -the funtions: +the function: ```python # nocl diff --git a/docs/quickstart.md b/docs/quickstart.md index 6f002b6..6cb1d9d 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -34,15 +34,14 @@ from Code Limit itself. When running as a hook, Code Limit *warns* about functions that *should* be refactored and *fails* for functions that *need* to be refactord. -To show your project uses Code Limit place this badge in the README markdown: -``` -![Checked with Code Limit](https://img.shields.io/badge/CodeLimit-checked-green.svg)](https://github.com/getcodelimit/codelimit) -``` - ## GitHub Action Code Limit is available as a GitHub Action +When running as a GitHub Action, Code Limit only checks modified files and +*warns* about functions that *should* be refactored and *fails* for functions +that *need* to be refactored. + To run Code Limit on every push and before every merge to `main`, append it to your GH Action workflow: