update readme

Author: popcron

README.md

@@ -1,18 +1,18 @@
-# Request Systems
+# Data Systems
 
-Implements `requests` with a system that imports data from various sources.
+Implements the `data` project with a system that loads data from various sources.
 
 ### Loading from an entity
 
 ```cs
-Datum source = new(world, "fileA");
+DataSource source = new(world, "fileA");
 source.WriteUTF8("Some data here!");
 
-Request request = new(world, "fileA");
+DataRequest request = new(world, "fileA");
 
 simulator.Update();
 
-using BinaryReader reader = new(request.GetBinaryData());
+using ByteReader reader = new(request.CreateByteReader());
 Span<char> dataBuffer = stackalloc char[32];
 uint textLength = reader.ReadUTF8Span(dataBuffer);
 string loadedData = dataBuffer.Slice(0, textLength).ToString();
@@ -22,11 +22,11 @@ Console.WriteLine($"Loaded data from an entity {loadedData}");
 ### Loading from file on disk
 
 ```cs
-Request request = new(world, "C:/fileB.txt");
+DataRequest request = new(world, "C:/fileB.txt");
 
 simulator.Update();
 
-using BinaryReader reader = new(request.GetBinaryData());
+using ByteReader reader = new(request.CreateByteReader());
 Span<char> dataBuffer = stackalloc char[32];
 uint textLength = reader.ReadUTF8Span(dataBuffer);
 string loadedData = dataBuffer.Slice(0, textLength).ToString();
@@ -46,13 +46,33 @@ public readonly struct MyEmbeddedResources : IEmbeddedResourceBank
 }
 
 EmbeddedResourceRegistry.Load<MyEmbeddedResources>();
-Request request = new(world, "Assets/test.txt");
+DataRequest request = new(world, "Assets/test.txt");
 
 simulator.Update();
 
-using BinaryReader reader = new(request.GetBinaryData());
+using ByteReader reader = new(request.CreateByteReader());
 Span<char> dataBuffer = stackalloc char[32];
 uint textLength = reader.ReadUTF8Span(dataBuffer);
 string loadedData = dataBuffer.Slice(0, textLength).ToString();
 Console.WriteLine($"Loaded data from an embedded resource {loadedData}");
+```
+
+### Loading through a message
+
+Data can be loaded by another system through the `LoadData` message:
+```cs
+LoadData message = new("Assets/test.txt");
+simulator.Broadcast(ref message);
+if (message.TryConsume(out ByteReader data))
+{
+    Span<char> dataBuffer = stackalloc char[32];
+    uint textLength = data.ReadUTF8Span(dataBuffer);
+    string loadedData = dataBuffer.Slice(0, textLength).ToString();
+    Console.WriteLine($"Loaded data through a message {loadedData}");
+    data.Dispose();
+}
+else
+{
+    Console.WriteLine("Failed to load data through a message");
+}
 ```

source/Data.Systems.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net9.0</TargetFramework>
@@ -10,7 +10,7 @@
     <Company>simulation-tree</Company>
     <RepositoryUrl>https://github.com/simulation-tree/data-systems</RepositoryUrl>
     <PackageReadmeFile>README.md</PackageReadmeFile>
-    <Description>Loads requests</Description>
+    <Description>Handles loading data</Description>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <IsAotCompatible>True</IsAotCompatible>
     <IsTrimmable>True</IsTrimmable>