Skip to content

Commit

Permalink
Updated Readme.md and .podspec
Browse files Browse the repository at this point in the history
Readded pod installation instruction, pod compatibility badge.
Added latest changes to Readme.
Updated .podspec to version 0.5.0.
  • Loading branch information
Mr-Alirezaa committed Sep 25, 2019
1 parent 2b0af7e commit 0d5003e
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 17 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Changelog
## Version 0.5.0
Since 0.2.0:
- Added a new initializer to `MapirServices` use access token without adding it to info.plist.
- Changed errors to be more expressive.
- Removed `MPS` prefix from every class and struct name.
Expand Down
2 changes: 1 addition & 1 deletion MapirServices.podspec
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Pod::Spec.new do |s|

s.name = "MapirServices"
s.version = "0.2.0"
s.version = "0.5.0"
s.summary = "a SDK to access services of map.ir."

s.homepage = "https://support.map.ir/"
Expand Down
40 changes: 24 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@
<img src="https://img.shields.io/badge/Swift-5.0-orange.svg?style=flat" alt="Swift 5.0">
</a>

<!---
<a href="http://cocoapods.org/pods/MapirServices">
<img src="https://img.shields.io/cocoapods/v/MapirServices.svg?style=flat" alt="Version">
</a>
<a href="http://cocoapods.org/pods/MapirServices">
<img src="https://img.shields.io/cocoapods/p/MapirServices.svg?style=flat" alt="Platform">
</a>
-->

<a href="https://github.com/Carthage/Carthage">
<img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage Compatible">
Expand All @@ -38,18 +36,15 @@ The example application is the best way to see `MapirServices` in action. Simply

## Installation

<!---
### CocoaPods

MapirServices is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:

```bash
```ruby
pod 'MapirServices'
```

-->

### Carthage

[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
Expand All @@ -70,17 +65,14 @@ To integrate using Apple's [Swift Package Manager](https://swift.org/package-man

```swift
dependencies: [
.package(url: "https://github.com/map-ir/ios-sdk-v1-services-beta", from: "0.1.0")
.package(url: "https://github.com/map-ir/ios-sdk-v1-services-beta", from: "0.5.0")
]
```


<!---
### Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate MapirServices into your project manually. Simply drag the `Sources` Folder into your Xcode project.
If you prefer not to use any of the aforementioned dependency managers, you can integrate MapirServices into your project manually. Simply drag the `Sources` Folder into your Xcode project. (not recommended)

-->

## Usage
1. Get an access token from [App Registration](https://corp.map.ir/registration/) site.
Expand All @@ -93,11 +85,27 @@ If you prefer not to use any of the aforementioned dependency managers, you can
```swift
let services = MPSMapirServices.shared
```

<!--
## Contributing
Contributions are very welcome 🙌
-->

## Latest Changes
### Version 0.5.0
- Added a new initializer to `MapirServices` use access token without adding it to info.plist.
- Changed errors to be more expressive.
- Removed `MPS` prefix from every class and struct name.
- Renamed `MPSLocation` to `Place`.
- Refactored the `DistanceMatrix` data structure. Finding distance between two place (by name) had O(N * M) time comlexity, but now it is O(1), So it's a lot faster.
- Added some utility methods to find distance and duration between places in DistanceMatrix.
- Refactored `distanceMatrix(from:to:option:completionHandler)` implementation. Input coordinates changed from `[CLLocationCoordinate2D]` to a `[String: CLLocationCoordinate2D]`. so every input coordinate has a name specified by the user itself and it helps to access distance and duration between coordinates by their name.
- Renamed search options to search categories.
- Changed `search(for:around:categories:filter:completionHandler:)` method result to a complete `Search` object. Search has a property named results of type `Search.Result> which contains the result of the search. This change helps user to have their selected options and categories along with the result of the search.
- Changed `autocomplete(for:around:categories:filter:completionHandler:)` to work the same as `search(for:around:categories:filter:completionHandler:)` to have the same functionality.
- Changed `route(from:to:routeMode:routeOptions:completionHandler:)` to `route(from:to:mode:options:completionHandler:)`. "route" term seemed obvious.
- All of methods run their prepration in a concurrent thread instead of main (UI) thread.
- Changed result of the `fastReverseGeocode(for:)` to be the same as `reverseGeocode(for:)`. an instance of `ReverseGeocode`.
- Added various documentation to the code itself.
- Removed unused and unnecessary files.
- Updated Examples and Playground files with the latest changes.

*__for more, see CHANGELOG.__*

## License

Expand Down

0 comments on commit 0d5003e

Please sign in to comment.