Skip to content

Commit b501362

Browse files
committed
chore: Update sample usage documentation for CountryData.Standard library
1 parent 2458aee commit b501362

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,11 @@ A simple cross-platform offline .NET library for getting Global Country Data wit
3434

3535
### Usage
3636

37-
This production-grade package can be used with .NET Core Webapi, .NET console applications, .NET Maui, Xamarin, Blazor, and mobile apps. It is compatible with both .NET Core and .NET Framework projects.
37+
CountryData.Standard is a robust, production-grade package designed for a wide range of .NET applications. Whether you're developing a .NET Core Web API, a console application, a .NET MAUI or Xamarin app, a Blazor project, or a mobile app, this library is built to seamlessly integrate with your project.
3838

39-
For detailed instructions on how to use the library, please refer to our [documentation](./docs/README.md ).
40-
41-
For a quick start, you can check out the `Simple code` folder provided in the repository.
39+
To get started quickly, check out our [Sample Code](./sample/README.md). This section provides practical examples of how to use the library in various types of projects.
4240

41+
For more detailed instructions and comprehensive information about the library, please refer to our [Documentation](./docs/README.md). This resource offers in-depth guidance on how to effectively use the CountryData.Standard library in your projects.
4342

4443

4544

@@ -94,14 +93,20 @@ foreach (var country in countriesWithPhoneCode)
9493

9594
```
9695

97-
## ISO-3166-1 country codes
96+
97+
### ISO-3166-1 country codes
9898

9999
For a list of supported ISO-3166-1 country codes, PhoneCode, Flags, ISO and , Unicode please refer to the [Country Details](./CountryData/CountryDetails.md) file.
100100

101101

102-
## Contributing
103102

104-
Contributions are welcome! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.Creating a `Code of Conduct` for your project involves defining the standards of behavior expected from contributors and maintainers. This document helps ensure that the community around your project is welcoming and collaborative. Here's a basic template you can use and customize for your project:
103+
### Contributing
104+
105+
Contributions are welcome! We value your input and want to make contributing to this project as easy and transparent as possible. Please see our [Contributing Guide](CONTRIBUTING.md) for more details.
106+
107+
### Code of Conduct
108+
109+
We are committed to fostering a welcoming and respectful community for everyone. Our `Code of Conduct` outlines the standards of behavior expected from contributors and maintainers. This document helps ensure that the community around our project is inclusive and collaborative. Please refer to our [code of conduct](CODE_OF_CONDUCT) for more information.
105110

106111

107112
### Comming Soon
@@ -111,6 +116,6 @@ Contributions are welcome! Please see our [Contributing Guide](CONTRIBUTING.md)
111116

112117

113118

114-
## License
119+
### License
115120

116121
This project is licensed under the terms of the [LICENSE](LICENSE).

sample/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ We provide several examples to help you understand how to effectively use the Co
55

66
## Console Application
77

8-
For a comprehensive example of how to use CountryData.Standard in a console application, please refer to our [Console Application Sample Code](./CountryData.Sample.Console/Program.cs). This sample demonstrates how to retrieve and display various country data.
8+
For a comprehensive example of how to use CountryData.Standard in a console application, please refer to our [Console Application Sample Code](./CountryData.Sample.Console/). This sample demonstrates how to retrieve and display various country data.
99

1010
## Web API
1111

0 commit comments

Comments
 (0)