Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyenLisa authored May 23, 2019
1 parent dbb0901 commit 9f7b01c
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ It can be used in an automated context to automatically construct fitting item s
The Delphi CLI checks the provided query and passes it on to the web API of the configured platform.
The results are printed to the console by default.

## How do I run Delphi CLI?

```
$ git clone https://github.com/delphi-hub/delphi-cli.git
$ cd delphi-cli/
$ sbt stage
$ cd target/universal/stage/bin
$ ./delphi [command] [options]
```

For the different commands and options, see [How can I use it?](#how-can-i-use-it)

## How can I use it?

The Delphi CLI is running on the Java Virtual Machine.
Expand All @@ -29,9 +41,9 @@ We require a Java Runtime Environment (JRE) in version 8 or newer.
Our software is available as a binary release on [GitHub](https://github.com/delphi-hub/delphi-cli/releases).

```
$ delphi-cli --help
$ delphi --help
Delphi Command Line Tool (1.0.0-SNAPSHOT)
Usage: delphi-cli [test|retrieve|search] [options] <args>...
Usage: delphi [test|retrieve|search] [options] <args>...
--version Prints the version of the command line tool.
--help Prints this help text.
Expand Down

0 comments on commit 9f7b01c

Please sign in to comment.