Skip to content

Commit d94c224

Browse files
committed
chore: update readme file, add breaking changes file
1 parent 17ae011 commit d94c224

File tree

2 files changed

+46
-9
lines changed

2 files changed

+46
-9
lines changed

BREAKING_CHANGES.md

Whitespace-only changes.

README.md

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,53 @@
11
# Cartography
2+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](LICENSE)![Version](https://img.shields.io/nuget/v/Cartography.DynamicMap?style=flat-square)![Downloads](https://img.shields.io/nuget/dt/Cartography.DynamicMap?style=flat-square)
23

3-
Nventive solution for mobile app map.
4+
Cartography provides you 3 map related libraries for IOS, Android and windows using native map of each platform.
45

5-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
6+
## **Cornerstones**
7+
- Add native map to your app.
8+
- If needed, Google map can be use on all platform.
9+
- The solution generate three independant nuget.
610

711
## Getting Started
812

913
### **Samples**
1014
- Clone project a sample is available.
1115
- For seeing samples, build and install app with VS on the desire device (Android, IOS, or UWP)
1216

13-
 
14-
## **DynamicMap**
17+
### API Key (not needed for mapService)
18+
- For Google map (Android), you need to [create your Api Key](https://developers.google.com/maps/documentation/javascript/get-api-key)
19+
- For Bing map, you should need a [Bing Api Key](https://learn.microsoft.com/en-us/bingmaps/getting-started/bing-maps-dev-center-help/getting-a-bing-maps-key) but work fine without it in sample.
20+
21+
set it in : sample.shared => Constants.
22+
23+
```csharp
24+
public class GoogleMaps
25+
{
26+
//TODO: Get new API Key
27+
public const string ApiKey = "";
28+
}
29+
```
30+
31+
### **DynamicMap**
32+
33+
- Setup your permission, in your AssemblyInfo of Android.
34+
- For windows location is in Package.appxmanifest under capabilities, select Location and Internet(Client).
35+
36+
```csharp
37+
//optional, if you need to locate user.
38+
[assembly: UsesPermission(Android.Manifest.Permission.AccessFineLocation)]
39+
[assembly: UsesPermission(Android.Manifest.Permission.AccessCoarseLocation)]
40+
41+
//Required, replace AppName by your Application Name.
42+
[assembly: UsesPermission("AppName.permission.MAPS_RECEIVE")]
43+
[assembly: Permission(Name = "AppName.permission.MAPS_RECEIVE", ProtectionLevel = Android.Content.PM.Protection.Signature)]
44+
45+
[assembly: UsesPermission("com.google.android.providers.gsf.permission.READ_GSERVICES")]
46+
47+
[assembly: MetaData("com.google.android.maps.v2.API_KEY", Value = Constants.GoogleMaps.ApiKey)]
48+
49+
```
50+
1551
- Add Cartography.DynamicMap NuGet package to your project.
1652
- In your ViewModel :
1753
```csharp
@@ -39,7 +75,7 @@ using Cartography.DynamicMap
3975
- Control can be added to your map : See [DynamicMapControl](Documentation/DynamicMapControl.md)
4076

4177
 
42-
## **StaticMap**
78+
### **StaticMap**
4379
- Add Cartography.StaticMap NuGet package to your project.
4480
- In your ViewModel :
4581
```csharp
@@ -57,7 +93,7 @@ using Cartography.StaticMap
5793
- Add Style StaticMapControl : see https://github.com/nventive/Cartography/blob/master/Samples/Samples/Samples.Shared/Views/Styles/StaticMapControl.xaml
5894
5995
 
60-
## **MapService**
96+
### **MapService**
6197
- Add Cartography.MapService NuGet package to your project.
6298
- In your ViewModel :
6399
```csharp
@@ -137,15 +173,16 @@ OR
137173
2. `Direction` : Open user default map service and show direction from User location to somewhere.
138174

139175

140-
## Changelog
176+
## Breaking Changes
177+
178+
Please consult the [BREAKING CHANGES](BREAKING_CHANGES.md) for the list of breaking changes.
141179

142180
Please consult the [CHANGELOG](CHANGELOG.md) for more information about version
143181
history.
144182

145183
## License
146184

147-
This project is licensed under the Apache 2.0 license - see the
148-
[LICENSE](LICENSE) file for details.
185+
This project is licensed under the [Apache 2.0 license](LICENSE).
149186

150187
## Contributing
151188

0 commit comments

Comments
 (0)