Merge pull request #3 from makeros/ver-2

BREAKING CHANGE: prepare new up to date version with different api th…
makeros · Sep 2, 2019 · d76b462 · d76b462
2 parents ef17d91 + 046197e
commit d76b462
Show file tree

Hide file tree

Showing 4 changed files with 293 additions and 383 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,19 +1,8 @@
-# Javascript Node CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-javascript/ for more details
-#
 version: 2
 jobs:
   build:
     docker:
-      # specify the version you desire here
       - image: circleci/node:10.15.2
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/mongo:3.4.4
-
     working_directory: ~/repo
 
     steps:
@@ -44,7 +33,6 @@ jobs:
       - restore_cache:
           keys:
             - v1-dependencies-{{ checksum "package.json" }}
-            # fallback to using the latest cache if no exact match is found
             - v1-dependencies-
       - run: npm test
 
@@ -59,26 +47,29 @@ jobs:
       - restore_cache:
           keys:
             - v1-dependencies-{{ checksum "package.json" }}
-            # fallback to using the latest cache if no exact match is found
             - v1-dependencies-
       - run: npx semantic-release
 
 workflows:
   version: 2
-  build_and_test:
+  build_test__release:
     jobs:
       - build
       - test:
           requires:
             - build
       - release_approval:
           type: approval
+          filters:
+            branches:
+              only:
+                - master
       - release:
           requires:
             - build
             - test
             - release_approval
-          filters:  # using regex filters requires the entire branch to match
+          filters:
             branches:
-              only:  # only branches matching the below regex filters will run
+              only:
                 - master
diff --git a/README.md b/README.md
@@ -1,16 +1,20 @@
-GELF Transformer
+GELF Transformer (ver. 2)
 ---
-This project is based on [Pino Glef](https://github.com/pinojs/pino-gelf)
+This project is based on [Pino Gelf](https://github.com/pinojs/pino-gelf)
 
 GELF transformer is a tool which receives json formatted logs from the stdin and transforms them into GELF format [GELF](https://docs.graylog.org/en/3.0/pages/gelf.html)
 It can also use a custom [mapping schema](###CustomFields)</sup> to fill the output log with more data.
 
+
+>[![CircleCI](https://circleci.com/gh/makeros/gelf-transformer/tree/master.svg?style=svg)](https://circleci.com/gh/makeros/gelf-transformer/tree/master)
+
+
 ### Contents
 
 * [Installation](##Installation)
 * [Usage](##Usage)
 * [Getting Started](##GettingStarted)
-* [Example I/O](##Example)
+* [Examples](##Examples)
 * [GELF](##GELF)
 * [Log Level Mapping](##LogLevelMapping)
 * [Acknowledgements](##Acknowledgements)
@@ -35,6 +39,10 @@ node your-app.js | gelf-transformer log <options>
 
 ### command `log`
 
+```
+gelf-transformer log --help
+```
+
 Switch | Description | Default | Notes
 ---|---|---|---
 `-h` | Host | `127.0.0.1` | Graylog server host