diff --git a/README.md b/README.md index ecb9ff6..163fdd3 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,31 @@ -# Code Climate CSSLint Engine +# Try Qlty today, the newest edition of Code Climate Quality. +#### This repository is deprecated and archived. -[![Code Climate](https://codeclimate.com/repos/558419b6e30ba012290173f6/badges/85c90e6df38db8a9492d/gpa.svg)](https://codeclimate.com/repos/558419b6e30ba012290173f6/feed) +This is a repository for a Code Climate Quality plugin which is packaged as a Docker image. -`codeclimate-csslint` is a Code Climate engine that wraps [CSSLint](https://github.com/CSSLint/csslint). You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform. +Code Climate Quality is being replaced with the new [Qlty](qlty.sh) code quality platform. Qlty uses a new plugin system which does not require packaging plugins as Docker images. -CSSLint helps point out problems with your CSS code. It does basic syntax checking as well as applying a set of rules that look for problematic patterns or signs of inefficiency. Each rule is pluggable, so you can easily write your own or omit ones you don't want. +As a result, this repository is no longer maintained and has been archived. -### Installation +## Advantages of Qlty plugins +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: -1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). -2. Run `codeclimate engines:enable csslint`. This command both installs the engine and enables it in your `.codeclimate.yml` file. -3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`. +- Linting runs much faster without the overhead of virtualization +- New versions of linters are available immediately without needing to wait for a re-packaged release +- Plugins can be run with any arbitrary extensions (like extra rules and configs) without requiring pre-packaging +- Eliminates security issues associated with exposing a Docker daemon -### Need help? +## Try out Qlty today free -For help with CSSLint, [check out their documentation](https://github.com/CSSLint/csslint). +[Qlty CLI](https://docs.qlty.sh/cli/quickstart) is the fastest linter and auto-formatter for polyglot teams. It is completely free and available for Mac, Windows, and Linux. -If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-csslint/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help). + - Install Qlty CLI: +` +curl https://qlty.sh | sh # Mac or Linux +` +or ` ` + +[Qlty Cloud](https://docs.qlty.sh/cloud/quickstart) is a full code health platform for integrating code quality into development team workflows. It is free for unlimited private contributors. + - [Try Qlty Cloud today](https://docs.qlty.sh/cloud/quickstart) + +**Note**: For existing customers of Quality, please see our [Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources.