readme

DomCR · DomCR · commit 9133555781b1 · 2022-05-28T09:17:02.000+02:00
diff --git a/CSHtml.Examples/BasicExample.cs b/CSHtml.Examples/BasicExample.cs
@@ -0,0 +1,61 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CSHtml.Examples
+{
+	public class BasicExamples
+	{
+		public static void WriteSimpleHtml()
+		{
+			HtmlBuilder builder = new HtmlBuilder();
+
+			using (builder.AddTag(HtmlTag.Html))
+			{
+				using (builder.AddTag(HtmlTag.Body, (HtmlAttribute.Class, "main_body")))
+				{
+					using (builder.AddTag(HtmlTag.H1))
+					{
+						builder.WriteLine("Heading");
+					}
+
+					using (builder.AddTag(HtmlTag.P))
+					{
+						builder.WriteLine("This is a paragraph");
+					}
+				}
+			}
+
+			Console.Write(builder.ToString());
+		}
+
+		public static void MultipleTags()
+		{
+			HtmlBuilder builder = new HtmlBuilder();
+
+			using (builder.AddTag(HtmlTag.Html))
+			{
+				using (builder.AddTag(HtmlTag.Body, (HtmlAttribute.Class, "main_body")))
+				{
+					using (builder.AddTag(HtmlTag.H2))
+					{
+						builder.WriteLine("Span with multiple tags");
+					}
+
+					using (builder.AddTag(HtmlTag.P))
+					{
+						builder.WriteLine("Define a span with the source, width and height");
+					}
+
+					using (builder.AddTag(HtmlTag.Span, (HtmlAttribute.Src, "my_icon.jpg"), (HtmlAttribute.Width, "100"), (HtmlAttribute.Height, "150")))
+					{
+					}
+				}
+			}
+
+			Console.Write(builder.ToString());
+		}
+	}
+}
diff --git a/CSHtml.Examples/ModularHtml.cs b/CSHtml.Examples/ModularHtml.cs
@@ -0,0 +1,12 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CSHtml.Examples
+{
+	public class ModularHtml
+	{
+	}
+}
diff --git a/CSHtml.Examples/Program.cs b/CSHtml.Examples/Program.cs
@@ -6,7 +6,9 @@ internal class Program
 	{
 		static void Main(string[] args)
 		{
-			Console.WriteLine("Hello World!");
+			BasicExamples.WriteSimpleHtml();
+
+			Console.ReadLine();
 		}
 	}
 }
diff --git a/CSHtml.Examples/SaveDocument.cs b/CSHtml.Examples/SaveDocument.cs
@@ -0,0 +1,12 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CSHtml.Examples
+{
+	public class SaveDocument
+	{
+	}
+}
diff --git a/CSHtml.sln b/CSHtml.sln
@@ -7,6 +7,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CSHtml", "CSHtml\CSHtml.csp
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSHtml.Examples", "CSHtml.Examples\CSHtml.Examples.csproj", "{C988E54A-1430-40B4-938B-6AF680E74DE3}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C4670E9B-7DF7-459B-8CFA-00B183847A85}"
+	ProjectSection(SolutionItems) = preProject
+		README.md = README.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
diff --git a/README.md b/README.md
@@ -1 +1,38 @@
-# CSHtml
+# CSHtml
+
+Library to write HTML documents using .NET
+
+## Syntax Example
+
+Example of basic html
+
+```html
+<html>
+    <body class="main_body">
+        <h1>Heading</h1>
+        <p>This is a paragraph</p>
+    </body>
+</html>
+```
+
+CSHtml syntact to write the html sample:
+
+```c#
+HtmlBuilder builder = new HtmlBuilder();
+
+using (builder.AddTag(HtmlTag.Html))
+{
+	using (builder.AddTag(HtmlTag.Body, (HtmlAttribute.Class, "main_body")))
+	{
+		using (builder.AddTag(HtmlTag.H1))
+		{
+			builder.WriteLine("Heading");
+		}
+
+		using (builder.AddTag(HtmlTag.P))
+		{
+			builder.WriteLine("This is a paragraph");
+		}
+	}
+}
+```

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,9 @@ internal class Program`
`6`	`6`	`{`
`7`	`7`	`static void Main(string[] args)`
`8`	`8`	`{`
`9`		`- Console.WriteLine("Hello World!");`
	`9`	`+ BasicExamples.WriteSimpleHtml();`
	`10`	`+`
	`11`	`+ Console.ReadLine();`
`10`	`12`	`}`
`11`	`13`	`}`
`12`	`14`	`}`