diff --git a/BingMapsRESTToolkit.sln b/BingMapsRESTToolkit.sln index 87fb1a9..9397aa1 100644 --- a/BingMapsRESTToolkit.sln +++ b/BingMapsRESTToolkit.sln @@ -11,9 +11,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution ProjectSection(SolutionItems) = preProject ..\..\..\..\Source\Repos\Bing-Maps-V8-TypeScript-Definitions\.gitignore = ..\..\..\..\Source\Repos\Bing-Maps-V8-TypeScript-Definitions\.gitignore CONTRIBUTING.md = CONTRIBUTING.md - Documentation.md = Documentation.md - LICENSE.txt = LICENSE.txt - README.txt = README.txt + LICENSE.md = LICENSE.md + README.md = README.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "WPF", "WPF", "{26E65B0F-9554-408A-95D4-BDEC52945FC3}" diff --git a/LICENSE.txt b/LICENSE.md similarity index 100% rename from LICENSE.txt rename to LICENSE.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..df03a2e --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +This is a portable .NET class library which provides a set of tools that make it easy to access the Bing Maps REST services in .NET based apps. + +## Getting Started ## + + + +## Features ## + +* Uses HTTPS by default. +* Imagery Metadata allows HTTPS tile urls to be returned. ???? +* Automatically encodes query parameters. A commonly overlooked stepped which greatly reduces th chances of invalid queries being sent to the service. +* Handles errors and rate limiting by catching exception and returning response with error message. +* Extentions added to make it easier to work with elevation data: + * Method to get the coordinates that relate to each elevation data point. + * Automatically determines if a POST request should be made. + +## Supports Target Platforms ## + +* .NET Framework 4.5+ +* ASP.NET Core 1.0 +* Universal Windows Platform (UWP) +* Windows 8 +* Windows 8.1 +* Windows Phone 8.1 +* Windows Phone 10 +* Windows Phone Silverlight 8 +* Windows Phone Silverlight 8.1 +* Xamarin.Android +* Xamarin.iOS +* Xamarin.iOS (Classic) + +## Additional Resources ## + +* [Bing Maps REST Services MSDN Documentation](https://msdn.microsoft.com/en-us/library/ff701713.aspx) +* [Bing Maps MSDN Docuemntation](https://msdn.microsoft.com/en-us/library/dd877180.aspx) +* [Bing Maps Blog](http://blogs.bing.com/maps) +* [Bing Maps forums](https://social.msdn.microsoft.com/Forums/en-US/home?forum=bingmapsajax&filter=alltypes&sort=lastpostdesc) +* [Bing Maps for Enterpise site](https://www.microsoft.com/maps/) + +## Contributing ## + +We welcome contributions. Feel free to file issues and pull requests on the repo and we'll address them as we can. Learn more about how you can help on our [Contribution Rules & Guidelines](CONTRIBUTING.md). + +You can reach out to us anytime with questions and suggestions using our communities below: +* [MSDN Forums](https://social.msdn.microsoft.com/Forums/en-US/home?forum=bingmapsajax&filter=alltypes&sort=lastpostdesc) +* [StackOverflow](http://stackoverflow.com/questions/tagged/bing-maps) + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +## License ## + +MIT + +See [License](LICENSE.md) for full license text. diff --git a/README.txt b/README.txt deleted file mode 100644 index 1715e2e..0000000 --- a/README.txt +++ /dev/null @@ -1,13 +0,0 @@ -Please report any bugs or issues to Ricky Brundritt: richbrun@microsoft.com - -Features: ---------- - -- Uses HTTPS by default. -- Imagery Metadata allows HTTPS tile urls to be returned. -- Automatically encodes query parameters. -- Handles errors and rate limiting by catching exception and returning response with error message. - -ElevationRequest - - Method to get the coordinates that relate to each elevation data point. - - Automatically determines if a POST request should be made.