Skip to content

Commit

Permalink
Add dedicated package README
Browse files Browse the repository at this point in the history
NuGet.org's content security policy and reduced Markdown rendering support mean that the project README doesn't render well in the NuGet gallery. Instead, add a dedicated package README with pared-back information that will render better.
  • Loading branch information
martincostello committed Mar 4, 2024
1 parent ef5816b commit 21e9d21
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<PackageIcon>package-icon.png</PackageIcon>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/justeattakeaway/JustSaying</PackageProjectUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageReadmeFile>package-readme.md</PackageReadmeFile>
<PackageReleaseNotes>$(PackageProjectUrl)/releases</PackageReleaseNotes>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<PackageTags>aws,sns,sqs</PackageTags>
Expand Down
19 changes: 19 additions & 0 deletions package-readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# JustSaying

[![NuGet](https://img.shields.io/nuget/v/JustSaying.svg?maxAge=3600)](https://www.nuget.org/packages/JustSaying/)
[![Build status](https://img.shields.io/github/actions/workflow/status/justeattakeaway/JustSaying/build.yml?branch=main&logo=github)](https://github.com/justeattakeaway/JustSaying/actions?query=workflow%3Abuild+branch%3Amain)
[![codecov](https://codecov.io/gh/justeattakeaway/JustSaying/branch/main/graph/badge.svg)](https://codecov.io/gh/justeattakeaway/JustSaying)

A helpful library for publishing and consuming events/messages over SNS (SNS/SQS as a message bus).

## Documentation

Documentation can be found [here](https://justeat.gitbook.io/justsaying/).

## Feedback

Any feedback or issues for this library can be added to the issues in [GitHub](https://github.com/justeattakeaway/JustSaying/issues "This package's issues on GitHub.com").

## License

This package is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html "The Apache 2.0 license") license.

0 comments on commit 21e9d21

Please sign in to comment.