@gram-data/gram-builder - npm Package Compare versions

Comparing version 0.2.7 to 0.2.8

package.json

@@ -8,3 +8,3 @@ {
   ],
-  "version": "0.2.7",
+  "version": "0.2.8",
   "license": "MIT",
@@ -68,5 +68,5 @@ "repository": {
   "dependencies": {
-    "@gram-data/gram-ast": "^0.2.7"
+    "@gram-data/gram-ast": "^0.2.8"
   },
-  "gitHead": "68f323250363f0ab629388565880339d5c94ed5e",
+  "gitHead": "3d28a7b7186d406e75bfd22aac54cd1b4ba0dbfa",
   "publishConfig": {
@@ -73,0 +73,0 @@ "access": "public"

README.md

@@ -1,5 +0,25 @@
-# Gram Builder
+From nothing to a valid gram AST.
 
-Build valid syntax trees that represent data graphs.
+## How to gram-builder
 
+### Install:
 
+```
+npm install @gram-data/gram-builder
+```
+
+### Build an AST using [[gram-builder]]:
+
+```
+import { node, edge } from '@gram-data/gram-builder';
+
+const left = node('a');
+const right = node('b');
+const ast = edge([left, right], 'right');
+```
+
+## Next Steps
+
+- Transform to js objects using [[gram-value]]
+- Write back to a string using [[gram-stringify]]
+- Introspect the AST using [[gram-ast]]

No alert changes

Improved metrics

Total package byte prevSize

140432

increased by0.28%

Number of lines in readme file

25

increased by316.67%

Dependency changes

• Updated@gram-data/gram-ast@^0.2.8