chore: Create read-me files for each package#225
Conversation
📝 WalkthroughWalkthroughUpdated MSBuild props to change how README.md is referenced for packaging and added three new README files documenting InterpolationCodeWriter packages (core, CSharp integration, and CSharp sources) with usage, installation, and compatibility details. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@src/InterpolationCodeWriter.CSharp.Sources/README.md`:
- Around line 17-40: The README's Quick Start names both ICodeWriter<T> and
CodeWriterDispatcher<T> but only shows an ICodeWriter<T> example; update the doc
so the text matches the sample by either (A) adding a short snippet that
demonstrates creating and using a CodeWriterDispatcher<T> with the MyWriter
implementation (show registering MyWriter with CodeWriterDispatcher<T> and
invoking dispatch) or (B) removing CodeWriterDispatcher<T> from the sentence so
it only references ICodeWriter<T>; locate references to ICodeWriter<T>,
CodeWriterDispatcher<T>, and the MyWriter example to adjust the content
accordingly.
Pull Request
The issue or feature being addressed
Details on the issue fix or feature implementation
Confirm the following
Summary by CodeRabbit