From d7ce80239c91085fb2d25cbb78956ae6986f0ee9 Mon Sep 17 00:00:00 2001 From: Darrell Warde <8117355+darrellwarde@users.noreply.github.com> Date: Thu, 31 Oct 2024 16:19:29 +0000 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 17f65cc..67090ab 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,27 @@ Downloadable binaries are available from the [releases](https://github.com/neo4j/cli/releases/latest) page. +Download the appropriate archive for for operating system and architecture. + +## Usage + +Extract the executable to a directory of your choosing. + +Create Aura API Credentials in your [Account Settings](https://console.neo4j.io/#account), and note down the client ID and secret. + +Add these credentials into the CLI with a name of your choosing: + +```bash +./neo4j-cli aura credential add --name "Aura API Credentials" --client-id --client-secret +``` + +This will add the credential and set it as the default credential for use. + +You can then, for example, list your instances: + +```bash +./neo4j-cli aura instance list + ## Development ### Testing