Skip to content

Commit

Permalink
doc(README): add build, config and start
Browse files Browse the repository at this point in the history
  • Loading branch information
aurrelhebert committed Jul 29, 2021
1 parent 94fccd0 commit 6da6c0f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,37 @@ Erlenmeyer is a Go Proxy used to parse multiple Open Source TimeSeries DataBase

![Erlenmeyer: Time Series query translator](./assets/logo.png)


## Building erlenmeyer

You can test and run locally erlenemeyer following those [building steps](./doc/BUILDING.md).

## Configuration

You can retrieve a `config.sample.yml` file, that can be re-used to configure erlenmeyer.

```sh
cp config.sample.yml /Path/to/erlenmeyer.yaml
```

In this config file, you will retrieve the Warp10 backend endpoint to set `warp_endpoint`. Erlenmeyer will use this endpoint to resolve WarpScript generated queries.

## Run

Run the dev compiled version:

```sh
./build/erlenmeyer --config /Path/to/erlenmeyer.yaml
```

Erlenmeyer supports some flags as `--listen` to specify erlenmeyer listen address and `--config` to specify the config file to use.

More information about the supported flags are provided by executing:

```sh
./build/erlenmeyer -h
```

## Supported protocols

| Name | State | Documentation |
Expand Down
4 changes: 3 additions & 1 deletion doc/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ And finally build the dev version
make dev
```

A `build` or `release` build targets are also available.

If you get any issue during compilation reset you go.mod file from Github:

```sh
Expand All @@ -58,7 +60,7 @@ To compile erlenmeyer release simply run:
make release
```

## Run
## Run

Run the dev compiled version:

Expand Down

0 comments on commit 6da6c0f

Please sign in to comment.