Ringloop / mr-plow

Minimal memory usage, cloud native logstash alternative
Apache License 2.0
28 stars 3 forks source link

Update README with config documentation #39

Closed feed3r closed 2 years ago

feed3r commented 2 years ago

Provide some documentation about the config

DarioBalinzo commented 2 years ago

I've added a minimal update of the examples, if for you is ok we can merge it, otherwise feel free to improve it ;)

codecov-commenter commented 2 years ago

Codecov Report

Merging #39 (c08f265) into main (bc7fd18) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #39   +/-   ##
=======================================
  Coverage   71.95%   71.95%           
=======================================
  Files           4        4           
  Lines         271      271           
=======================================
  Hits          195      195           
  Misses         42       42           
  Partials       34       34           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bc7fd18...c08f265. Read the comment docs.

DarioBalinzo commented 2 years ago

Also, can you add in the comments or with a final description at the end of the file the complete list of type supported by the cast? (integer, string etc) using the exact keyword with the correct case as the code.

feed3r commented 2 years ago

I added the list of supported types in this sentence:

Actually supported type are: String, Integer, Float and Boolean

case is not important, since the type parsing is case insensitive.

Is it not clear, on your opinion?

DarioBalinzo commented 2 years ago

my fault, it is ok for me! you can merge it