diff --git a/README.md b/README.md index ac7d300..e862742 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,6 @@ # Record API New version (v3) of the Record API that is for the first time decoupled from Search API -## Build -To build (requires the [CoreLib](https://github.com/europeana/corelib) dependency): - -Configure your maven settings: http://artifactory.eanadev.org/artifactory/webapp/mavensettings.html?1 - -```bash -$ git clone https://github.com/europeana/corelib.git -$ cd corelib -$ mvn clean install - -$ git clone https://github.com/europeana/api2.git -$ cd api2 -$ mvn clean install -``` - ## Deploy To deploy your instance you can use the Docker files in `docker/compose` folder. This image contains Tomcat only. However at the moment we do not have a Mongo database or Solr engine in Docker yet. @@ -25,3 +10,8 @@ The addresses and login credentials of all these services are specified in the e credentials for services that are not dockerized yet). **Make sure you never commit these changes!** It's safer to place these login credentials in a europeana.user.properties file in the same folder because this file is set to be ignored by git. All settings in the europeana.user.properties will override those in the europeana.properties. + + +# Europeana Record API + +[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=europeana_record-api)](https://sonarcloud.io/summary/new_code?id=europeana_record-api)