-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated LICENSE and README.md files.
- Loading branch information
1 parent
c765760
commit a015708
Showing
2 changed files
with
44 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2019 Map | ||
Copyright (c) 2019 Map [email protected] | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,44 @@ | ||
<p align="center"> | ||
<img width="200" src="https://raw.githubusercontent.com/SvenTiigi/SwiftKit/gh-pages/readMeAssets/SwiftKitLogo.png" alt="MapirServices Logo"> | ||
<img width="200" src="https://corp.map.ir/wp-content/uploads/2019/06/map-site-logo-1.png" alt="MapirServices Logo"> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://developer.apple.com/swift/"> | ||
<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"> | ||
</a> | ||
<a href="https://github.com/apple/swift-package-manager"> | ||
<img src="https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg" alt="SPM"> | ||
</a> | ||
<a href="https://developer.apple.com/swift/"> | ||
<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"> | ||
</a> | ||
<a href="https://github.com/apple/swift-package-manager"> | ||
<img src="https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg" alt="SPM"> | ||
</a> | ||
</p> | ||
|
||
# MapirServices | ||
|
||
<p align="center"> | ||
ℹ️ Short description of MapirServices | ||
ℹ️ MapirServices framework, helps you with networking part of using services of map.ir | ||
</p> | ||
|
||
## Features | ||
|
||
- [x] ℹ️ Add MapirServices features | ||
- ℹ️ Support for All version 1 API of Map.ir | ||
|
||
## Example | ||
|
||
The example application is the best way to see `MapirServices` in action. Simply open the `MapirServices.xcodeproj` and run the `Example` scheme. | ||
|
||
## Installation | ||
|
||
<!--- | ||
### CocoaPods | ||
MapirServices is available through [CocoaPods](http://cocoapods.org). To install | ||
|
@@ -45,14 +48,16 @@ it, simply add the following line to your Podfile: | |
pod 'MapirServices' | ||
``` | ||
--> | ||
|
||
### Carthage | ||
|
||
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. | ||
|
||
To integrate MapirServices into your Xcode project using Carthage, specify it in your `Cartfile`: | ||
|
||
```ogdl | ||
github "Alireza Asadi/MapirServices" | ||
github "map-ir/ios-sdk-v1-services-beta" | ||
``` | ||
|
||
Run `carthage update` to build the framework and drag the built `MapirServices.framework` into your Xcode project. | ||
|
@@ -65,26 +70,40 @@ To integrate using Apple's [Swift Package Manager](https://swift.org/package-man | |
|
||
```swift | ||
dependencies: [ | ||
.package(url: "https://github.com/Alireza Asadi/MapirServices.git", from: "1.0.0") | ||
.package(url: "https://github.com/map-ir/ios-sdk-v1-services-beta", from: "0.1.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. | ||
## Usage | ||
|
||
ℹ️ Describe the usage of your Kit | ||
--> | ||
|
||
## Usage | ||
1. Get an access token from [App Registration](https://corp.map.ir/registration/) site. | ||
2. Add a key-value pair of your access token to your project's info.plist. Key must be "`MAPIRAccessToken`" | ||
3. First import SDK using | ||
```swift | ||
import MapirServices | ||
``` | ||
4. create an singleton instance of the `MPSMapirServiecs` class whenever you want to use these services | ||
```swift | ||
let services = MPSMapirServices.shared | ||
``` | ||
|
||
<!-- | ||
## Contributing | ||
Contributions are very welcome 🙌 | ||
--> | ||
|
||
## License | ||
|
||
``` | ||
MapirServices | ||
Copyright (c) 1398 Map [email protected] | ||
Copyright (c) 2019 Map [email protected] | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
|