Skip to content

Commit b2e6e20

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

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

BREAKING_CHANGES.md

Whitespace-only changes.

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Cartography
22

3-
Nventive solution for mobile app map.
3+
[![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)
4+
5+
### **Description**
6+
Cartography adds map functionalities to your Uno app.
7+
8+
### **Goal**
9+
Provides solutions for fully interactive map, simple static map or native map services.
410

511
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
612

@@ -11,7 +17,7 @@ Nventive solution for mobile app map.
1117
- For seeing samples, build and install app with VS on the desire device (Android, IOS, or UWP)
1218

1319
 
14-
## **DynamicMap**
20+
### **DynamicMap**
1521
- Add Cartography.DynamicMap NuGet package to your project.
1622
- In your ViewModel :
1723
```csharp
@@ -39,7 +45,7 @@ using Cartography.DynamicMap
3945
- Control can be added to your map : See [DynamicMapControl](Documentation/DynamicMapControl.md)
4046

4147
 
42-
## **StaticMap**
48+
### **StaticMap**
4349
- Add Cartography.StaticMap NuGet package to your project.
4450
- In your ViewModel :
4551
```csharp
@@ -57,7 +63,7 @@ using Cartography.StaticMap
5763
- Add Style StaticMapControl : see https://github.com/nventive/Cartography/blob/master/Samples/Samples/Samples.Shared/Views/Styles/StaticMapControl.xaml
5864
5965
 
60-
## **MapService**
66+
### **MapService**
6167
- Add Cartography.MapService NuGet package to your project.
6268
- In your ViewModel :
6369
```csharp
@@ -137,15 +143,16 @@ OR
137143
2. `Direction` : Open user default map service and show direction from User location to somewhere.
138144

139145

140-
## Changelog
146+
## Breaking Changes
147+
148+
Please consult the [BREAKING CHANGES](BREAKING_CHANGES.md) for the list of breaking changes.
141149

142150
Please consult the [CHANGELOG](CHANGELOG.md) for more information about version
143151
history.
144152

145153
## License
146154

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

150157
## Contributing
151158

0 commit comments

Comments
 (0)