add a readme

Author: GreemDev

README.md

@@ -0,0 +1,60 @@
+# Starscript.Net
+
+[![NuGet Version](https://img.shields.io/nuget/v/Starscript.Net)](https://www.nuget.org/packages/Starscript.Net/)
+[![NuGet Downloads](https://img.shields.io/nuget/dt/Starscript.Net)](https://www.nuget.org/packages/Starscript.Net/)
+
+Fast text formatting language for C#. This is a .NET port of [starscript by MeteorDevelopment](https://github.com/MeteorDevelopment/starscript/), written in Java.
+Licensed under MIT.
+
+- Lightweight; No dependencies. Just .NET 9.
+- Standard operators: + - * / % ^
+- Ability to call functions defined in C#
+- Variables can be different each time they are used
+- Conditional output (ternary operator)
+- Variables can be maps
+
+## Examples
+- `Hello {name}!`
+- `Number: {someNumber * 100}`
+- `FPS: {round(fps)}`
+- `Today is a {good ? 'good' : 'bad'} day`
+- `Name: {user.name}`
+
+## Usage:
+You can find the latest version number at the top of this README. With that:
+
+Your .csproj:
+```xml
+<PackageReference Include="Starscript.Net" Version="{version}" />
+```
+
+
+In your code:
+```csharp
+using Starscript;
+
+// Parse
+if (!Parser.TryParse(@"Hello {name}! Starscript was originally created by {originalAuthor()}", out Parser.Result result)) 
+{
+    foreach (var error in result.Errors)
+        Console.WriteLine(error);
+    
+    return;
+}
+
+// Compile
+Script script = Compiler.SingleCompile(result); 
+// The compiler also has the ability to batch compile and directly compile from source (throwing a ParseException if any errors are present)
+
+// Create Starscript hypervisor instance
+StarscriptHypervisor hv = StarscriptHypervisor.Create()
+    .WithStandardLibrary(); // Adds the default functions, not required
+
+hv.Set("name", () => "GreemDev"); // dynamic variable
+hv.Set("originalAuthor", _ => "MineGame159"); // function
+
+// Run
+Console.WriteLine(hv.Run(script));
+// or...
+Console.WriteLine(script.Execute(hv));
+```

Starscript.Net.sln

@@ -6,6 +6,13 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Starscript.Net.Tests", "src
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Starscript.Net.TestProgram", "src\TestProgram\Starscript.Net.TestProgram.csproj", "{3046ED02-73C4-49D7-A697-4995642D2921}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{36F870C1-3E5F-485F-B426-F0645AF78751}"
+	ProjectSection(SolutionItems) = preProject
+		README.md = README.md
+		.github\workflows\main.yml = .github\workflows\main.yml
+	EndProjectSection
+EndProject
+
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU