add sample readme (#1)

Author: marschattha

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Code Climate, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,33 @@
+# Qlty Rust Coverage Example
+
+[Qlty](https://example.com) is a Code Health Platform with support for code coverage.
+
+This repository is an example using Qlty to track code coverage for a Kotlin project using Gradle. Coverage data is generated during the [Kotlin](https://kotlinlang.org/) build, and then uploaded to Qlty.
+
+This repository uses [jacoco](https://github.com/jacoco/jacoco) to generate an xml code coverage file.
+
+## Requirements
+
+- Gradle 8.x or above
+- Kotlin 1.9.x or above
+- Jacoco v0.8.0 or above
+- Test run with [gradle test](https://docs.gradle.org/current/userguide/java_testing.html#sec:test_execution) or via your IDE
+- An account on Qlty (free for open source)
+- `QLTY_COVERAGE_TOKEN` is set as a GitHub Actions [repository secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)
+
+## Set up
+
+See [`.github/workflows/main.yml`](./.github/workflows/main.yml) in this repository for a basic configuration.
+
+## Documentation
+
+- [Advanced code coverage configuration](https://example.com)
+- [Alternative supported CI providers](https://example.com)
+
+## Help and feedback
+
+Join the our [Slack Community](https://example.com) for help and to provide feedback that we'll use to improve Qlty.
+
+## License
+
+[MIT License](./LICENSE.md)