From 8981528ffa3ae0eefca322d63a5bb9f0f069d778 Mon Sep 17 00:00:00 2001
From: "Cemal Y. Dalar" <cemal@dalar.net>
Date: Sat, 9 Dec 2023 08:40:16 +0100
Subject: [PATCH] Docs (#20)

alpha 13
---
 .goreleaser.yml |  2 +-
 README.md       | 30 +++++++++++++++++++++++++++++-
 mermaid.md      | 30 ++++++++++++++++++++++++++++++
 3 files changed, 60 insertions(+), 2 deletions(-)
 create mode 100644 mermaid.md

diff --git a/.goreleaser.yml b/.goreleaser.yml
index 82ee4dc..e0f3849 100644
--- a/.goreleaser.yml
+++ b/.goreleaser.yml
@@ -37,7 +37,7 @@ builds:
 
 archives:
   - id: repl
-    name_template: "{{ .ProjectName }}-{{.Os}}-{{.Arch}}"
+    name_template: "{{ .ProjectName }}_{{.Os}}_{{.Arch}}_{{.Version}}"
     format: tar.gz
     format_overrides:
       - goos: windows
diff --git a/README.md b/README.md
index e1e42a0..ba8a21d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
-# parampiper
\ No newline at end of file
+# parampiper
+
+parampiper is a tool for manage parameters across between systems/environments. 
+
+
+
+[![build](https://github.com/cdalar/parampiper/actions/workflows/build.yml/badge.svg)](https://github.com/cdalar/parampiper/actions/workflows/build.yml)
+[![Go Report Card](https://goreportcard.com/badge/github.com/cdalar/parampiper)](https://goreportcard.com/report/github.com/cdalar/parampiper)
+[![codecov](https://codecov.io/gh/cdalar/parampiper/graph/badge.svg?token=7VU7H1II09)](https://codecov.io/gh/cdalar/parampiper)
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cdalar/parampiper?sort=semver)
+<!-- [![Known Vulnerabilities](https://snyk.io/test/github/cdalar/parampiper/main/badge.svg)](https://snyk.io/test/github/cdalar/parampiper/main) -->
+
+## What parampiper brings 
+
+- single source of truth (SSOT). All you parameters in one place.
+- works on a simple json file. 
+- support several backends (local file, azure blob)
+
+## Installation
+
+### MacOS
+
+```
+brew install cdalar/tap/parampiper
+```
+
+### Linux
+
+
diff --git a/mermaid.md b/mermaid.md
new file mode 100644
index 0000000..1b3628a
--- /dev/null
+++ b/mermaid.md
@@ -0,0 +1,30 @@
+## Bash Script 
+```mermaid
+flowchart LR
+
+X(parampiper get p_name)--> A(Bash Script) -->B(parampiper set p_name)
+Y(parampiper out --export) --> A
+%% B --> C{Decision}
+%% C -->|One| D[Result 1]
+%% C -->|Two| E[Result 2]
+%% X(parampiper get p_name <a href='http://google.com'>link</a>)--> A(Bash Script) -->B(parampiper set p_name)
+```
+
+## Powershell Script 
+```mermaid
+flowchart LR
+
+X(parampiper get p_name)--> A(Powershell Script) -->B(parampiper set p_name)
+Y(parampiper out --export) --> A
+```
+
+## Terraform
+```mermaid
+flowchart LR
+X(parampiper out --tfvars)--> A(Terraform) -->B(parampiper import -tfshowjson)
+
+```
+
+## Bicep
+
+TBD
\ No newline at end of file