Release v1.0.0

amirisback · Mar 17, 2020 · 98d125a · 98d125a
1 parent 90a0737
commit 98d125a
Show file tree

Hide file tree

Showing 2 changed files with 101 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,43 @@ Simple code and reusable data
 https://newsapi.org/
 
 # Function Main From This Project
+    // Switch For Using Chuck Interceptor
+    fun usingChuckInterceptor(context: Context)
+
+    // Get Top Headline
+    fun getTopHeadline(
+        q: String?,
+        sources: String?,
+        category: String?,
+        country: String?,
+        pageSize: Int?,
+        page: Int?,
+        callback: NewsResultCallback<ArticleResponse>
+    )
+
+    // Get Everythings
+    fun getEverythings(
+        q: String?,
+        from: String?,
+        to: String?,
+        qInTitle: String?,
+        sources: String?,
+        domains: String?,
+        excludeDomains: String?,
+        language: String?,
+        sortBy: String?,
+        pageSize: Int?,
+        page: Int?,
+        callback: NewsResultCallback<ArticleResponse>
+    )
+
+    // Get Sources
+    fun getSources(
+        language: String,
+        country: String,
+        category: String,
+        callback: NewsResultCallback<SourceResponse>
+    )
 
 # Android Library Version (build.gradle)
 - ext.kotlin_version = '1.3.70'
@@ -29,14 +66,62 @@ https://newsapi.org/
 # Version Release
 This Is Latest Release
 
-    $version_release = Still on development
+    $version_release = 1.0.0
 
 What's New??
 
-    * Development *
+    * Fetching All Function on News Api *
 
 # How To Use This Project
-- Release soon
+<h3>Step 1. Add the JitPack repository to your build file</h3>
+
+Add it in your root build.gradle at the end of repositories:
+
+	allprojects {
+		repositories {
+			...
+			maven { url 'https://jitpack.io' }
+		}
+	}
+
+
+<h3>Step 2. Add the dependency</h3>
+
+	dependencies {
+	        // library consumable code news api
+            implementation 'com.github.amirisback:consumable-code-news-api:$version_release'
+	}
+
+<h3>Step 3. Declaration ConsumeNewsApi</h3>
+
+	val consumeNewsApi = ConsumeNewsApi(NewsUrl.NEWS_API_KEY) // Your API_KEY
+    consumeNewsApi.usingChuckInterceptor(this) // Using Chuck Interceptor
+    consumeNewsApi.getTopHeadline( // Adding Base Parameter on main function
+        null, 
+        null,
+        null,
+        "id",
+        null,
+        null,
+        object : NewsResultCallback<ArticleResponse> {
+            override fun getResultData(data: ArticleResponse) {
+                // Your Ui or data
+            }
+
+            override fun failedResult(statusCode: Int, errorMessage: String?) {
+                // Your failed to do
+            }
+
+            override fun onShowProgress() {
+                // Your Progress Show
+            }
+
+            override fun onHideProgress() {
+                // Your Progress Hide
+            }
+
+        })
+
 
 # Colaborator
 Very open to anyone, I'll write your name under this, please contribute by sending an email to me

diff --git a/app/src/main/java/com/frogobox/newsapi/MainActivity.kt b/app/src/main/java/com/frogobox/newsapi/MainActivity.kt
@@ -13,7 +13,7 @@ class MainActivity : AppCompatActivity() {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
 
-        val consumeNewsApi = ConsumeNewsApi(NewsUrl.NEWS_API_KEY)
+        val consumeNewsApi = ConsumeNewsApi(NewsUrl.NEWS_API_KEY) // Your API_KEY
         consumeNewsApi.usingChuckInterceptor(this)
         consumeNewsApi.getTopHeadline(
             null,
@@ -23,13 +23,21 @@ class MainActivity : AppCompatActivity() {
             null,
             null,
             object : NewsResultCallback<ArticleResponse> {
-                override fun getResultData(data: ArticleResponse) {}
+                override fun getResultData(data: ArticleResponse) {
+                    // Your Ui or data
+                }
 
-                override fun failedResult(statusCode: Int, errorMessage: String?) {}
+                override fun failedResult(statusCode: Int, errorMessage: String?) {
+                    // Your failed to do
+                }
 
-                override fun onShowProgress() {}
+                override fun onShowProgress() {
+                    // Your Progress Show
+                }
 
-                override fun onHideProgress() {}
+                override fun onHideProgress() {
+                    // Your Progress Hide
+                }
 
             })