From b501362038c829bfcfc2ce89eed0a403731637fb Mon Sep 17 00:00:00 2001 From: Isaiah Clifford Opoku Date: Tue, 11 Jun 2024 10:05:30 +0000 Subject: [PATCH] chore: Update sample usage documentation for CountryData.Standard library --- README.md | 21 +++++++++++++-------- sample/README.md | 2 +- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 47fa7c4..33b04cf 100644 --- a/README.md +++ b/README.md @@ -34,12 +34,11 @@ A simple cross-platform offline .NET library for getting Global Country Data wit ### Usage -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. +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. -For detailed instructions on how to use the library, please refer to our [documentation](./docs/README.md ). - -For a quick start, you can check out the `Simple code` folder provided in the repository. +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. +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. @@ -94,14 +93,20 @@ foreach (var country in countriesWithPhoneCode) ``` -## ISO-3166-1 country codes + +### ISO-3166-1 country codes 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. -## Contributing -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: +### Contributing + +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. + +### Code of Conduct + +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. ### Comming Soon @@ -111,6 +116,6 @@ Contributions are welcome! Please see our [Contributing Guide](CONTRIBUTING.md) -## License +### License This project is licensed under the terms of the [LICENSE](LICENSE). diff --git a/sample/README.md b/sample/README.md index 20a346e..d115dd0 100644 --- a/sample/README.md +++ b/sample/README.md @@ -5,7 +5,7 @@ We provide several examples to help you understand how to effectively use the Co ## Console Application -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. +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. ## Web API