Skip to content

Commit 1ab3165

Browse files
authored
Add README to Package (wayfair-incubator#60)
1 parent 0c3f2d1 commit 1ab3165

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

Diff for: README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
[![Stargazers][stars-shield]][stars-url]
1616
[![Issues][issues-shield]][issues-url]
1717

18-
[![MIT License][license-shield]][license-url]
18+
[![Apache 2.0 License][license-shield]][license-url]
1919

2020
## About The Project
2121

@@ -84,21 +84,21 @@ IEnumerable<MyDataType> listResult = await list.ReadAllAsync(CancellationToken.N
8484
// listResult contains [ MyDataType("list item 1"), MyDataType("list item 2") ]
8585
```
8686

87-
Full library documentation can be found at the [docs site](https://wayfair-incubator.github.io/AeroSharp/)
87+
Full library documentation can be found at the [docs site](https://wayfair-incubator.github.io/AeroSharp/).
8888

89-
Code examples can be found in the [examples directory](./examples)
89+
Code examples can be found in the [examples directory](https://github.com/wayfair-incubator/AeroSharp/tree/main/examples).
9090

9191
## Roadmap
9292

9393
See the [open issues](https://github.com/wayfair-incubator/AeroSharp/issues) for a list of proposed features (and known issues).
9494

9595
## Contributing
9696

97-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. For detailed contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md)
97+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. For detailed contributing guidelines, please see [CONTRIBUTING.md](https://github.com/wayfair-incubator/AeroSharp/blob/main/CONTRIBUTING.md).
9898

9999
## License
100100

101-
Distributed under the `Apache 2.0` License. See [LICENSE](LICENSE) for more information.
101+
Distributed under the `Apache 2.0` License. See [LICENSE](https://github.com/wayfair-incubator/AeroSharp/blob/main/LICENSE) for more information.
102102

103103
## Contact
104104

Diff for: src/AeroSharp/AeroSharp.csproj

+5
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@
1212
<RepositoryUrl>https://github.com/wayfair-incubator/AeroSharp</RepositoryUrl>
1313
<RepositoryType>git</RepositoryType>
1414
<PackageTags>aerospike, aerosharp, serialization, policy validation</PackageTags>
15+
<PackageReadmeFile>README.md</PackageReadmeFile>
1516
</PropertyGroup>
1617

1718
<ItemGroup>
19+
<None Include="..\..\README.md">
20+
<Pack>True</Pack>
21+
<PackagePath>\</PackagePath>
22+
</None>
1823
<None Include="..\..\LICENSE">
1924
<Pack>True</Pack>
2025
<PackagePath></PackagePath>

0 commit comments

Comments
 (0)