-
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.
Merge branch 'master' of https://github.com/KaveNegar/kavenegar-java
- Loading branch information
Showing
1 changed file
with
103 additions
and
45 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,19 +1,89 @@ | ||
| #Java SDK | ||
| # <a href="http://kavenegar.com/rest.html">Kavenegar RESTful API Document</a> | ||
| #Java-example | ||
| # [Kavenegar RESTful API Document](http://kavenegar.com/rest.html) | ||
| If you need to future information about API document Please visit RESTful Document | ||
|
|
||
| ## Installation | ||
| <p> | ||
| First of all, You need to make an account on Kavenegar from <a href="https://panel.kavenegar.com/Client/Membership/Register">Here</a> | ||
| </p> | ||
| <p> | ||
| After that you just need to pick API-KEY up from <a href="http://panel.kavenegar.com/Client/setting/index">My Account</a> section. | ||
| Here You can download the Java SDK <a href="https://github.com/KaveNegar/kavenegar-java/archive/master.zip">Here</a> or just pull it. | ||
| Anyway there is good tutorial about <a href="http://gun.io/blog/how-to-github-fork-branch-and-pull-request/">Pull request</a> | ||
| </p> | ||
| First of all, You need to make an account on Kavenegar from [Kaveneagr webpage](https://panel.kavenegar.com/Client/Membership/Register) | ||
|
|
||
|
|
||
| After that you just need to pick API-KEY up from [My Account](http://panel.kavenegar.com/Client/setting/index) section. | ||
| Here You can download the [Java SDK] (https://github.com/KaveNegar/kavenegar-java/archive/master.zip) or just pull it. | ||
| Anyway there is good tutorial about [Pull request](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/) | ||
|
|
||
| ### To get a Git project into your build: | ||
|
|
||
| Add it depend on what you are using . | ||
|
|
||
| #### gradle | ||
| Step 1 <p> Add the JitPack repository to your build file </p> | ||
|
|
||
| ```java | ||
| allprojects { | ||
| repositories { | ||
| ... | ||
| maven { url 'https://jitpack.io' } | ||
| } | ||
| } | ||
| ``` | ||
| Step 2<p>Add the dependency</p> | ||
|
|
||
| ```java | ||
| dependencies { | ||
| compile 'com.github.User:Repo:Tag' | ||
| } | ||
| ``` | ||
| #### maven | ||
|
|
||
| Step 1 <p> Add the JitPack repository to your build file </p> | ||
|
|
||
| ```java | ||
| <repositories> | ||
| <repository> | ||
| <id>jitpack.io</id> | ||
| <url>https://jitpack.io</url> | ||
| </repository> | ||
| </repositories> | ||
| ``` | ||
| Step 2<p>Add the dependency</p> | ||
|
|
||
| ```java | ||
| <dependency> | ||
| <groupId>com.github.User</groupId> | ||
| <artifactId>Repo</artifactId> | ||
| <version>Tag</version> | ||
| </dependency> | ||
| ``` | ||
| #### sbt | ||
|
|
||
| Step 1 <p> Add the JitPack repository to your build file </p> | ||
|
|
||
| ```java | ||
| resolvers += "jitpack" at "https://jitpack.io" | ||
|
|
||
| ``` | ||
| Step 2<p>Add the dependency</p> | ||
|
|
||
| ```java | ||
| libraryDependencies += "com.github.User" % "Repo" % "Tag" | ||
|
|
||
| ``` | ||
| #### leiningen | ||
|
|
||
| Step 1 <p> Add the JitPack repository to your build file </p> | ||
|
|
||
| ```java | ||
| :repositories [["jitpack" "https://jitpack.io"]] | ||
|
|
||
| } | ||
| ``` | ||
| Step 2<p>Add the dependency</p> | ||
|
|
||
| ```java | ||
| :dependencies [[com.github.User/Repo "Tag"]] | ||
|
|
||
| ``` | ||
| ## Usage | ||
| Well, There is an example to Send SMS by Java. | ||
| Well,You can see an example of sending SMS through JAVA below . | ||
|
|
||
| ```java | ||
|
|
||
|
|
@@ -32,37 +102,25 @@ catch (ApiException ex) | |
|
|
||
| ``` | ||
|
|
||
| #Contribution | ||
| Bug fixes, docs, and enhancements welcome! Please let us know <a href="mailto:[email protected]?Subject=SDK" target="_top">[email protected]</a> | ||
|
|
||
|
|
||
|
|
||
| ## Persian tutorial / راهنمای فارسی | ||
| <div style="direction:rtl"> | ||
| ###راهنما | ||
| در صورتی که مایل هستید راهنمای فارسی کیت توسعه کاوه نگار را مطالعه کنید به سفحه | ||
| <a href="http://kavenegar.com/sdk.html">کد ارسال پیامک</a> | ||
| مراجعه کنید | ||
|
|
||
| ###مستندات | ||
| <p> | ||
| برای مطالعه مستندات کار با | ||
| <a href="http://kavenegar.com" target="_blank">وب سرویس اس ام اس</a> | ||
| کاوه نگار به سفحه <a href="http://kavenegar.com/rest.html">مستندات</a>مراجعه کنید | ||
| </p> | ||
| ###معرفی وب سرویس کاوه نگار | ||
| <p> | ||
| برای مشاهده ویژگی های | ||
| <a href="http://kavenegar.com/%D9%88%D8%A8-%D8%B3%D8%B1%D9%88%DB%8C%D8%B3-%D9%BE%DB%8C%D8%A7%D9%85%DA%A9.html"> | ||
| وب سرویس پیامک | ||
| </a> | ||
| کاوه نگار به صفحه وب سرویس مراجعه نمائید | ||
| </p> | ||
| ### ایجاد حساب کاربری | ||
| <p> | ||
| و بالاخره اگر در استفاده از سرویس کاوه نگار مشکلی داشتید یا پیشنهاد همکاری بود لطفا حتما به ما اطلاع دهید | ||
| <br> | ||
| <a href="mailto:[email protected]">[email protected]</a> | ||
|
|
||
| </p> | ||
| </div> | ||
| # Contribution | ||
|
|
||
| Bug fixes, docs, and enhancements welcome!I know that there are so many people do these thingi you're one of the just | ||
| please let us know [[email protected]](mailto:[email protected]?Subject=SDK) | ||
| <hr> | ||
| <div dir='rtl'> | ||
|
|
||
| <h4 id="">راهنمای فارسی</h4> | ||
| <h5 id="-1">راهنما</h5> | ||
| <p>در صورتی که مایل هستید راهنمای فارسی کیت توسعه کاوه نگار را مطالعه کنید به صفحه | ||
| <a href="http://kavenegar.com/sdk.html">کد ارسال پیامک</a> | ||
| مراجعه کنید.</p> | ||
| <h5 id="-2">مستندات</h5> | ||
| <p>برای مطالعه مستندات کار با | ||
| <a href="http://kavenegar.com"> وب سرویس اس ام اس</a> | ||
| کاوه نگار به صفحه <a href="http://kavenegar.com/rest.html">مستندات</a>مراجعه کنید</p> | ||
| <h5 id="-3">معرفی وب سرویس کاوه نگار</h5> | ||
| <p>برای مشاهده ویژگی های وب سرویس پیامک کاوه نگار به <a href="http://kavenegar.com/%D9%88%D8%A8%D8%B3%D8%B1%D9%88%DB%8C%D8%B3-%D9%BE%DB%8C%D8%A7%D9%85%DA%A9.html">صفحه وب سرویس</a>مراجعه نمائید.</p> | ||
| <h5 id="-4">ایجاد حساب کاربری</h5> | ||
| <p>و بالاخره اگر در استفاده از سرویس کاوه نگار مشکلی داشتید یا پیشنهاد همکاری بود لطفا حتما به ما اطلاع دهید.</p> | ||
| <p><a href="mailto:[email protected]">[email protected]</a></p> | ||
| </div> | ||