diff --git a/README.md b/README.md index 2aacb27e5aef9c..eb65a19e9b607c 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ For more, see the [documentation](https://docs.astral.sh/ruff/). 1. [Who's Using Ruff?](#whos-using-ruff) 1. [License](#license) -## Getting Started +## Getting Started For more, see the [documentation](https://docs.astral.sh/ruff/). @@ -195,7 +195,7 @@ jobs: - uses: chartboost/ruff-action@v1 ``` -### Configuration +### Configuration Ruff can be configured through a `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file (see: [_Configuration_](https://docs.astral.sh/ruff/configuration/), or [_Settings_](https://docs.astral.sh/ruff/settings/) @@ -291,7 +291,7 @@ features that may change prior to stabilization. See `ruff help` for more on Ruff's top-level commands, or `ruff help check` and `ruff help format` for more on the linting and formatting commands, respectively. -## Rules +## Rules @@ -367,21 +367,21 @@ quality tools, including: For a complete enumeration of the supported rules, see [_Rules_](https://docs.astral.sh/ruff/rules/). -## Contributing +## Contributing Contributions are welcome and highly appreciated. To get started, check out the [**contributing guidelines**](https://docs.astral.sh/ruff/contributing/). You can also join us on [**Discord**](https://discord.com/invite/astral-sh). -## Support +## Support Having trouble? Check out the existing issues on [**GitHub**](https://github.com/astral-sh/ruff/issues), or feel free to [**open a new one**](https://github.com/astral-sh/ruff/issues/new). You can also ask for help on [**Discord**](https://discord.com/invite/astral-sh). -## Acknowledgements +## Acknowledgements Ruff's linter draws on both the APIs and implementation details of many other tools in the Python ecosystem, especially [Flake8](https://github.com/PyCQA/flake8), [Pyflakes](https://github.com/PyCQA/pyflakes), @@ -405,7 +405,7 @@ Ruff is the beneficiary of a large number of [contributors](https://github.com/a Ruff is released under the MIT license. -## Who's Using Ruff? +## Who's Using Ruff? Ruff is used by a number of major open-source projects and companies, including: @@ -524,7 +524,7 @@ If you're using Ruff, consider adding the Ruff badge to your project's `README.m Ruff ``` -## License +## License This repository is licensed under the [MIT License](https://github.com/astral-sh/ruff/blob/main/LICENSE)