Initial commit

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5930586
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# GitLab License Management
+
+[![pipeline status](https://gitlab.com/gitlab-org/security-products/license_management/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/security-products/license_management/commits/master)
+[![coverage report](https://gitlab.com/gitlab-org/security-products/license_management/badges/master/coverage.svg)](https://gitlab.com/gitlab-org/security-products/license_management/commits/master)
+
+GitLab tool for detecting licenses of the dependencies used by the provided source.
+It is currently based on License Finder only, but this may change in the future.
+
+## How to use
+
+1. `cd` into the directory of the source code you want to scan
+1. Run the Docker image:
+
+    ```sh
+    docker run \
+      --volume "$PWD":/code \
+      registry.gitlab.com/gitlab-org/security-products/license_management:latest /code
+    ```
+
+1. The results will be stored in the `gl-license-management-report.json` file in the application directory. `gl-license-management-report.html` is also available with a human readable report.
+
+# Contributing
+
+If you want to help, read the [contribution guidelines](CONTRIBUTING.md).