Skip to content

Commit a636d13

Browse files
Ross McDonaldRoss McDonald
authored andcommitted
improve REAME add installation instructions
1 parent e1c155f commit a636d13

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,40 @@
22

33
Command line interface for Protean.
44

5+
6+
## Installation
7+
8+
[Download](https://github.com/passivsystems/protean-cli/releases/download/0.4.0/protean-cli-0.4.0.tgz) the release.
9+
Unzip/extract tar and place the two files in the same location on your path somewhere.
10+
511
## Usage
612

13+
java -jar protean.jar
14+
15+
or
16+
717
protean
818

919
will show usage instructions.
1020

1121
protean services
1222

23+
or
24+
25+
java -jar protean.jar services
26+
1327
will list configured services.
1428

15-
We recommend 'drip' (github.com/flatland/drip) to speed things up with the command line.
29+
We recommend 'drip' (github.com/flatland/drip) to speed things up with the command line. The sample script uses drip.
30+
1631

1732
## Build
1833

1934
lein uberjar
2035

2136
if you want to build from source
2237

38+
2339
## License
2440

2541
Protean CLI is licensed with Apache License v2.0.

0 commit comments

Comments
 (0)