Skip to content

Commit 226d209

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

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

BREAKING_CHANGES.md

Whitespace-only changes.

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Cartography
22

3-
Nventive solution for mobile app map.
3+
### **Description**
4+
Cartography adds map functionalities to your Uno app.
5+
6+
### **Goal**
7+
Provides solutions for fully interactive map, simple static map or native map services.
48

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

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

1317
 
14-
## **DynamicMap**
18+
### **DynamicMap**
1519
- Add Cartography.DynamicMap NuGet package to your project.
1620
- In your ViewModel :
1721
```csharp
@@ -39,7 +43,7 @@ using Cartography.DynamicMap
3943
- Control can be added to your map : See [DynamicMapControl](Documentation/DynamicMapControl.md)
4044

4145
 
42-
## **StaticMap**
46+
### **StaticMap**
4347
- Add Cartography.StaticMap NuGet package to your project.
4448
- In your ViewModel :
4549
```csharp
@@ -57,7 +61,7 @@ using Cartography.StaticMap
5761
- Add Style StaticMapControl : see https://github.com/nventive/Cartography/blob/master/Samples/Samples/Samples.Shared/Views/Styles/StaticMapControl.xaml
5862
5963
 
60-
## **MapService**
64+
### **MapService**
6165
- Add Cartography.MapService NuGet package to your project.
6266
- In your ViewModel :
6367
```csharp
@@ -137,17 +141,20 @@ OR
137141
2. `Direction` : Open user default map service and show direction from User location to somewhere.
138142

139143

140-
## Changelog
144+
## Repository
145+
146+
### Changelog
141147

142148
Please consult the [CHANGELOG](CHANGELOG.md) for more information about version
143149
history.
144150

145-
## License
151+
Please consult the [BREAKING CHANGES](BREAKING_CHANGES.md) for the list of breaking changes.
152+
153+
### 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

150-
## Contributing
157+
### Contributing
151158

152159
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for
153160
contributing to this project.

0 commit comments

Comments
 (0)