From a32740245fc3a6e864d838ffa94a009d5d3dad37 Mon Sep 17 00:00:00 2001 From: Richard Conway Date: Thu, 5 Oct 2023 12:55:19 +0100 Subject: [PATCH] Update README.md Fix documentation links, and remove obsolete `Usage` --- README.md | 26 +++----------------------- 1 file changed, 3 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 6c4b1d6..284e7c4 100644 --- a/README.md +++ b/README.md @@ -97,32 +97,12 @@ docker-compose up ## Documentation -The component documentation can be found at https://eoepca.github.io/rm-workspace-api/. +Documentation for the Workspace API: +* [Wiki Pages](https://github.com/EOEPCA/rm-workspace-api/wiki) +* [Design documentation](https://eoepca.github.io/rm-workspace-api/) - placeholders ~ still to be done -## Usage - -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. - -_For more examples, please refer to the [Documentation](https://example.com)_ - -### Running the template service - -Just execute the run task in Gradle - -```sh -./gradlew run -``` - -### Upgrading Gradle Wrapper - -Change the version number in the `build.gradle` wrapper task then run: - -```sh -./gradlew wrapper --gradle-version=4.10.2 --distribution-type=bin -``` - ## Roadmap