Merge pull request #41 from laura-mlg/patch-1

Update with deprecation notice.md

Author: brynary

README.md

@@ -1,25 +1,31 @@
-# Code Climate PMD Engine
+# Try Qlty today, the newest edition of Code Climate Quality.
+#### This repository is deprecated and archived.
 
-`codeclimate-pmd` is a Code Climate engine that wraps the [PMD](https://pmd.github.io) static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.
+This is a repository for a Code Climate Quality plugin which is packaged as a Docker image.
 
-### Installation
+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.
 
-1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
-2. Run `codeclimate engines:enable pmd`. 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`.
-4. To add you custom PMD rules, open `.codeclimate.yml` and add a `config` entry pointing to your `ruleset.xml` file:
-```yml
-engines:
-  pmd:
-    enabled: true
-    config: ruleset.xml
-```
+As a result, this repository is no longer maintained and has been archived.
 
-### Need help?
+## Advantages of Qlty plugins
+The new Qlty plugins system provides key advantages over the older, Docker-based plugin system:
 
-For help with PMD, [check out their documentation](https://pmd.github.io/).
+- 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
 
-If you're running into a Code Climate issue, first check out [our PMD engine docs][cc-docs-pmd] and look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues),
-as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).
+## Try out Qlty today free
 
-[cc-docs-pmd]: https://docs.codeclimate.com/docs/pmd
+[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.
+
+  - Install Qlty CLI:
+`
+curl https://qlty.sh | sh # Mac or Linux
+`
+or ` <windows install line> `
+
+[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.