First version

1 files changed, 45 insertions, 3 deletions

diff --git a/README.md b/README.md
index 5930586..d58ebf8 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # 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)
+[![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.
@@ -14,11 +14,53 @@ It is currently based on License Finder only, but this may change in the future.
     ```sh
     docker run \
       --volume "$PWD":/code \
-      registry.gitlab.com/gitlab-org/security-products/license_management:latest /code
+      --rm \
+      registry.gitlab.com/gitlab-org/security-products/license-management:latest analyze /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.
 
+## Development
+
+### Running the application
+
+License Management is a Docker image, you can build it like any Docker image like so in the
+project root:
+
+```sh
+docker build -t license-management .
+```
+
+You can then run License Management on some target directory:
+
+```sh
+docker run --rm --volume "/path/to/my/project":/code license-management analyze /code
+```
+
+You can run integration tests on the image like this:
+
+```sh
+docker run --rm license-management /test/test.sh
+```
+
+## Supported languages and package managers
+
+The following table shows which languages and package managers are supported.
+
+| Language   | Package managers                                                  |
+|------------|-------------------------------------------------------------------|
+| JavaScript | [Bower](https://bower.io/), [npm](https://www.npmjs.com/)         |
+| Go         | [Godep](https://github.com/tools/godep), go get                   |
+| Java       | [Gradle](https://gradle.org/), [Maven](https://maven.apache.org/) |
+| .NET       | [Nuget](https://www.nuget.org/)                                   |
+| Python     | [pip](https://pip.pypa.io/en/stable/)                             |
+| Ruby       | [gem](https://rubygems.org/)                                      |
+
+
+## Versioning and release process
+
+Please check the [Release Process documentation](https://gitlab.com/gitlab-org/security-products/release/blob/master/docs/release_process.md).
+
 # Contributing
 
 If you want to help, read the [contribution guidelines](CONTRIBUTING.md).