zaphar/ucg
1
0
Fork 0
mirror of https://github.com/zaphar/ucg.git synced 2025-07-22 18:19:54 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Update the README with new features.

Browse Source
This commit is contained in:
Jeremy Wall 2017-11-29 18:49:20 -06:00
parent 389f395383
commit 2b01e8611b
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -18,7 +18,7 @@ preferred format.
#### Base Types #### Base Types
UCG has 3 simple types Integer, Float, and String as well as Tuple for complex UCG has 3 simple types Integer, Float, and String as well as Tuple and List for complex
types. types.
1; 1;
@ -32,8 +32,12 @@ types.
field2 = "strawberry", field2 = "strawberry",
}; };
[1, 2, 3, 4];
To specify that a number is a Float you must include a decimal point. Otherwise To specify that a number is a Float you must include a decimal point. Otherwise
the number will be an integer. UCG does type inference for tuple fields based the number will be an integer.
UCG does type inference for tuple fields based
off of the value assigned. off of the value assigned.
### Simple Expressions ### Simple Expressions
@ -60,7 +64,7 @@ This gets turned into "foo 1 bar {"
Let statements introduce a new name in a UCG file. Most configurations Let statements introduce a new name in a UCG file. Most configurations
will be a tuple like below. Tuples are delimited by braces and have a list will be a tuple like below. Tuples are delimited by braces and have a list
of named fields in them. of named fields in them. Fields in a tuple can be indexed using dotted selectors.
let mysql_conn_base = { let mysql_conn_base = {
host = "db1.local.net", host = "db1.local.net",
@ -68,9 +72,20 @@ of named fields in them.
database = "place-holder", database = "place-holder",
}; };
let mysql_host = mysql_conn_base.host;
Tuple fields have no ordering guarantees. All bindings are immutable and Tuple fields have no ordering guarantees. All bindings are immutable and
can not be reassigned to once defined. can not be reassigned to once defined.
### Lists
Lists are an ordered collection of elements. Lists can be indexed using dotted selectors. List indexes start at 0.
let hosts = ["db1.local.net", "db2.local.net"];
let host1 = hosts.0;
let host2 = hosts.1;
### Variables ### Variables
UCG can reference a binding using variables. Any named value using UCG can reference a binding using variables. Any named value using