diff --git a/README.adoc b/README.adoc index 107578b..f9420dc 100644 --- a/README.adoc +++ b/README.adoc @@ -12,30 +12,21 @@ A minimal implementation of Nexus repository to practice Vert.x * [x] Jitpack. .Snapshots -* [x] Enable snapshots. +* [x] Enable snapshot repositories of above mirrors. .Publishing artifacts -* [ ] Publish artifacts to Kumoru. (_Contemplating_) +* [x] Publish artifacts to Kumoru. .HTTP methods supported * [x] GET +* [x] PUT == Pre-Requisites -1. JDK 11 +1. Java 11 2. Docker -== Building and Running Locally - -To build your application: -``` -./gradlew clean build -``` - -To package your application into Docker container: -``` -./gradlew jibDockerBuild -``` +== Running the server To run your application: ``` @@ -52,4 +43,73 @@ docker run -e KUMORU_ACCESS_LOG=true -p 8888:8888 -v /tmp/repo:/srv/repo rishabh > All logs are written to the `STDOUT`. +== Configuring Maven + +.Mirroring +Edit Maven's `settings.xml` and add a ``: + +``` + + + kumoru + * + Kumoru - A minimal Nexus repository + http://localhost:8888 + + + +``` + +.Publishing + +In your `pom.xml` add + +``` + + + kumoru + Kumoru - A minimal Nexus repository + http://localhost:8888 + + +``` + +== Configuring Gradle +.Mirroring + +Add to you `build.gradle` + +``` +repositories { + maven { + url: "http://localhost:8080" + } +} +``` + +.Publishing + +Add to your `build.gradle` + +``` +publishing { + repositories { + maven { + url: "http://localhost:8080" + } + } +} +``` + +== Building the code + +To build your application: +``` +./gradlew clean build +``` + +To package your application into Docker container: +``` +./gradlew jibDockerBuild +```