Skip to content

Commit

Permalink
Add download binary option in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
caldito committed Mar 23, 2024
1 parent 8bf9e75 commit fc0ce4b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,19 @@ Dependencies:
Command `make run` does the same but it will also start the server.

## Running the server
- **Option 1: Docker** `docker run -p 20000:20000 pablogcaldito/mimcas-server:v0.1.0 [ARGUMENTS]`
- **Option 2: Build the source** `make && ./bin/mimcas-server [ARGUMENTS]`.
- **Option 1: Docker:** `docker run -p 20000:20000 pablogcaldito/mimcas-server:v0.1.0 [ARGUMENTS]`
- **Option 2: Download and run binary:** download from [releases page](https://github.com/caldito/mimcas/releases/) and run `./mimcas-server [ARGUMENTS]`
- **Option 3: Build from source:** `make && ./bin/mimcas-server [ARGUMENTS]`.
### Server flags
None of them are required. The available flags are:
- `-port`: Port to use for listening for incoming connections. By default it will be `20000`.
- `-maxmemory`: Maximum number of bytes available to use. Items will be evicted following LRU policy when that limit is crossed. By default there is no limit.

## Connecting with a client
The only client for now is the CLI one. It will available when building the source code as well.
- **Option 1: Docker** `docker run --network host -it pablogcaldito/mimcas-cli:v0.1.0 mimcas-cli [ARGUMENTS]`
- **Option 2: Build the source** `make && ./bin/mimcas-cli [ARGUMENTS]`.
- **Option 1: Docker:** `docker run --network host -it pablogcaldito/mimcas-cli:v0.1.0 mimcas-cli [ARGUMENTS]`
- **Option 2: Download and run binary:** download from [releases page](https://github.com/caldito/mimcas/releases/) and run `./mimcas-cli [ARGUMENTS]`
- **Option 3: Build from source:** `make && ./bin/mimcas-cli [ARGUMENTS]`.

### Client flags
None of them are required. The available flags are:
Expand Down

0 comments on commit fc0ce4b

Please sign in to comment.