Merge pull request #3 from jamplate/0.3.0

0.3.0

Author: LSafer

.gitignore

@@ -16,3 +16,6 @@ gradle-app.setting
 
 # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
 # gradle/wrapper/gradle-wrapper.properties
+
+# Scrache Tests
+ScratchMainTest.java

Intellij.md

@@ -6,7 +6,7 @@ standard C pre-processors with some features added and some missing.
 
 ### Distribution
 
-This repository is the core processor and contain no application. You might use the
+This repository is the core processor. You might use the
 [Jamplate Gradle Plugin](https://github.com/jamplate/gradle) instead. If you want to use
 the processor directly or just extend it, you might download the repository or
 use `jitpack.io`. For more info, please visit [jamplate.org](https://jamplate.org)
@@ -22,6 +22,56 @@ dependencies {
 }
 ```
 
+### Usage
+
+An example of using the Glucose Implementation:
+
+```groovy 
+    Document document = new PseudoDocument(
+        //name
+        "main.jamplate",
+        //content
+        "#message Hello ' ' World"
+    )
+    
+    Unit unit = new UnitImpl(new GlucoseSpec())
+    
+    if (
+        !unit.initialize(document) ||
+        !unit.parse(document) ||
+        !unit.analyze(document) ||
+        !unit.compile(document) ||
+        !unit.execute(document)
+    ) {
+    	unit.diagnostic()
+    }
+```
+
+An example of using the Glucose Implementation with the DebugSpec:
+
+```groovy 
+    Document document = new PseudoDocument(
+        //name
+        "main.jamplate",
+        //content
+        "#{ Hello ' ' World }#"
+    )
+
+    Unit unit = new UnitImpl(new GlucoseSpec(
+        DebugSpec.INSTANCE
+    ))
+
+    if (
+        !unit.initialize(document) ||
+        !unit.parse(document) ||
+        !unit.analyze(document) ||
+        !unit.compile(document) ||
+        !unit.execute(document)
+    ) {
+        unit.diagnostic()
+    }
+```
+
 ### Project Info
 
 - GitHub Repository:

README.md

@@ -13,7 +13,7 @@ repositories {
 }
 
 dependencies {
-	implementation 'org.cufy:nodes:0.0.9'
+	implementation 'org.cufy:nodes:0.1.0'
 	implementation 'org.json:json:20210307'
 
 	testImplementation 'org.junit.jupiter:junit-jupiter:5.7.1'