Skip to content

Commit

Permalink
Add usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
svghadi committed Dec 12, 2022
1 parent 2110cc3 commit a0343d1
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,29 @@

### Server

Build the server using below instructions or use the container image to start the server.

```bash
docker run --name file-store-server -p 8080:8080 sghadi1203/file-store:latest
```

### Client

Build the client using below instructions or use the binary from github release page of this repo.

```bash
# set server address for client
$ export FILE_STORE_SERVER="http://localhost:8080"

$ store help
Help
ls List all files from store.
add file1 file2... Add files to store store.
update file1 file2... Update files in store store.
rm file1 file2... Remove files from store store.
freq-words --limit 10|-n 10 --order dsc|asc List count of each word. limit & order are optional flags.
```

## Build Instructions

#### Server Build
Expand Down

0 comments on commit a0343d1

Please sign in to comment.