From f5bdbe9b792a8256ca637345c245690f4564cbc8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jes=C3=BAs=20P=C3=A9rex?= <jpl@jesusperez.com>
Date: Thu, 26 Jun 2025 23:19:54 +0100
Subject: [PATCH] init repo

---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..95363ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# nu_plugin_tera
+
+A [Nushell](https://nushell.sh/) plugin to use [Tera templates](https://keats.github.io/tera/docs/).
+
+## Installing
+
+Clone this repository 
+
+Build from source 
+
+```nushell
+> cargo install --path .
+```
+
+### Nushell 
+
+In a [Nushell](https://nushell.sh/)
+
+```nushell
+> plugin add ~/.cargo/bin/nu_plugin_tera
+```
+
+## Usage
+
+```nushell
+> tera-render <template> (context)
+```
+
+Flags:
+- **-h**, **--help**: Display the help message for this command
+
+Parameters:
+- **template** <path>: Ruta al archivo .tera
+- **context** <any>: Datos de contexto (record o JSON path) (optional)
+
+
+### Examples
+
+Render **template.tera** with a record as context from the pipeline.
+
+template.tera:
+```jinja
+Hello, {{ name }}!Projects:
+{% for project in projects -%}
+- {{ project.name }} ({{ project.status }})
+{% endfor %}
+```
+
+### Other options
+
+```nushell
+> open data.json | wrap value | tera-render template.tera
+> open data.json | tera-render template.tera
+> { name: 'Akasha', projects: [ {'name': 'TheProject' , 'status': 'active' }]  } | tera-render template.tera
+```
+
+Result: 
+<pre>
+  Hello, Akasha!
+  Projects:
+  - TheProject (active)
+</pre>
+