summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorJo-Philipp Wich <jo@mein.io>2022-03-28 11:14:13 +0200
committerJo-Philipp Wich <jo@mein.io>2022-03-28 11:14:13 +0200
commitaae5312a6f117ebb4e12ae500d8d3001d59d2db3 (patch)
treed509115b91123ab60e1193bde33e8d50e0b5eb12 /README.md
parent87c72961c6e18a56caf5bac6b48196ccb8532336 (diff)
Update README.md
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7ae085a..24cd264 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,17 @@
## ABOUT
-An ucode template consists of arbitrary plain text which is outputted as-is
-while control flow or expression logic is embedded in blocks that may appear
-anywhere throughout the template.
+The ucode language is a tiny general purpose scripting language featuring a
+syntax closely resembling ECMAScript. It can be used in a stand-alone manner
+by using the ucode command line interpreter or embedded into host applications
+by linking libucode and utilizing its C language API. Additionally, ucode can
+be invoked in template mode where control flow and expression logic statements
+are embedded in Jinja-like markup blocks.
+
+Besides aiming for small size, the major design goals of ucode are the ability
+to trivially read and write JSON data, good embeddability into C applications,
+template capabilities for output formatting, extensiblity through loadable
+native extension modules and a straightforward set of builtin functions
+mimicking those found in the Perl 5 language.
## BLOCKS