Skip to content

Update README with comprehensive documentation#22

Merged
kerryjiang merged 2 commits intomasterfrom
copilot/update-readme
Jan 31, 2026
Merged

Update README with comprehensive documentation#22
kerryjiang merged 2 commits intomasterfrom
copilot/update-readme

Conversation

Copy link
Contributor

Copilot AI commented Jan 31, 2026

README was minimal—just a build badge, one-liner description, and spec links. Updated to match SuperSocket ecosystem standards and address user requests for examples (issue #19).

Changes

  • Badges: Added NuGet version and download count
  • Features: Listed key capabilities (MQTT 3.1.1, topic wildcards, .NET 6-9 support)
  • Installation: NuGet commands for all three packages
  • Quick Start: Working server and client examples
  • Project Structure: Package descriptions table

Server Example

var host = SuperSocketHostBuilder
    .Create<MQTTPacket>()
    .UseMQTT()
    .UseInProcSessionContainer()
    .ConfigureAppConfiguration((hostCtx, configApp) =>
    {
        configApp.AddInMemoryCollection(new Dictionary<string, string?>
        {
            { "serverOptions:name", "MQTTServer" },
            { "serverOptions:listeners:0:ip", "Any" },
            { "serverOptions:listeners:0:port", "1883" }
        });
    })
    .Build();

await host.RunAsync();

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: kerryjiang <456060+kerryjiang@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README for clarity and information Update README with comprehensive documentation Jan 31, 2026
Copilot AI requested a review from kerryjiang January 31, 2026 08:24
@kerryjiang kerryjiang marked this pull request as ready for review January 31, 2026 08:38
@kerryjiang kerryjiang merged commit ea58d2f into master Jan 31, 2026
3 checks passed
@kerryjiang kerryjiang deleted the copilot/update-readme branch January 31, 2026 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants