Skip to content

Modernize README and NuGet metadata for discoverability - #35

Merged
woksin merged 4 commits into
mainfrom
docs/modernize-readme-and-nuget-metadata
Aug 28, 2026
Merged

Modernize README and NuGet metadata for discoverability#35
woksin merged 4 commits into
mainfrom
docs/modernize-readme-and-nuget-metadata

Conversation

@woksin

@woksin woksin commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Improve how the Specifications project is found and understood — clearer positioning in the README, accurate cross-links to the wider Cratis ecosystem, and searchable NuGet package metadata.

Changed

  • Modernized the README: Specification by Example (BDD) tagline, MIT license and Discord badges, neutral voice, and a fixed build badge link target
  • Added related-project and Cratis ecosystem sections linking Synopsis, Chronicle, Arc, and the rest of the stack
  • Added a shared NuGet package description and tags (bdd, specification-by-example, xunit, nunit, mspec, given-when-then) with per-framework descriptions for the XUnit and NUnit packages

woksin added 2 commits August 28, 2026 00:51
Lead with a Specification by Example (BDD) tagline, fix the build badge
link target (cratis-system -> Cratis), add MIT license and Discord
badges, move the introduction to a neutral voice, and add related
project and Cratis ecosystem sections linking Synopsis, Chronicle,
Arc, and the rest of the stack.
Set a shared Description and PackageTags (bdd, specification-by-example,
xunit, nunit, mspec, given-when-then) in Directory.Build.props and
override the description per test framework in the XUnit and NUnit
packages.
@woksin
woksin merged commit 22b706c into main Aug 28, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant