documentation updates, bug fix (#13)

Co-authored-by: jeffrey-elliott <[email protected]>
Co-authored-by: Steve Hewitt <[email protected]>

Author: a-random-steve

images/logo.svg

@@ -5,8 +5,28 @@
     <ImplicitUsings>disable</ImplicitUsings>
     <Nullable>disable</Nullable>
     <LangVersion>10.0</LangVersion>
+
+    <PackageId>DataStax.AstraDB.DataApi</PackageId>
+    <Version>1.0.0</Version>
+    <Authors>DataStax</Authors>
+    <Company>DataStax</Company>
+    <Description>Client library for accessing the DataStax Astra DB Data API from .NET applications.</Description>
+    <Copyright>Copyright (c) DataStax 2025</Copyright>
+    <PackageTags>astradb;datastax;serverless;dataapi</PackageTags>
+    <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+    <PackageProjectUrl>https://docs.datastax.com/en/astra-db-serverless</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/datastax/astra-db-csharp</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+    <PackageIcon>packageIcon.png</PackageIcon>
+    <Readme>README.md</Readme>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="packageIcon.png" Pack="true" PackagePath="\" />
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.0" />
     <PackageReference Include="Microsoft.Extensions.Http" Version="9.0.0" />

src/DataStax.AstraDB.DataApi/DataStax.AstraDB.DataApi.csproj

@@ -0,0 +1,40 @@
+# Overview
+
+This C# Client Library simplifies using the DataStax Data API to manage and interact with AstraDB instances as well as other DataStax databases.
+
+# Installation
+
+```
+dotnet add package DataStax.AstraDB.DataApi
+```
+
+# Quickstart
+
+```
+//instantiate a client
+var client = new DataApiClient("YourTokenHere");
+
+//connect to a database
+var database = client.GetDatabase("YourDatabaseUrlHere");
+
+//create a new collection
+var collection = await database.CreateCollectionAsync<SimpleObject>("YourCollectionNameHere");
+
+//insert a document into the collection
+var documents = new List<SimpleObject>
+{
+    new SimpleObject()
+    {
+        Name = "Test Object 1",
+    },
+    new SimpleObject()
+    {
+        Name = "Test Object 2",
+    }
+};
+var insertResult = await collection.InsertManyAsync(documents);
+
+//find a document
+var filter = Builders<SimpleObject>.Filter.Eq(so => so.Name, "Test Object 1");
+var results = await collection.Find(filter);
+```

src/DataStax.AstraDB.DataApi/README.md

@@ -21,6 +21,7 @@
 using System.Linq.Expressions;
 using System.Reflection;
 using System.Text;
+using System.Text.Json.Serialization;
 
 namespace DataStax.AstraDB.DataApi.Utils;
 
@@ -64,14 +65,18 @@ private static void BuildPropertyName(MemberExpression memberExpression, StringB
         var name = memberExpression.Member.Name;
         if (memberExpression.Member is PropertyInfo propertyInfo)
         {
+            var jsonPropertyNameAttribute = propertyInfo.GetCustomAttribute<JsonPropertyNameAttribute>();
+            if (jsonPropertyNameAttribute != null)
+            {
+                name = jsonPropertyNameAttribute.Name;
+            }
             var attribute = propertyInfo.GetCustomAttribute<DocumentMappingAttribute>();
             if (attribute != null && attribute.Field == DocumentMappingField.Id)
             {
                 name = DataApiKeywords.Id;
             }
         }
         sb.Append(name);
-
     }
 
 }