fix naming (#27)

Author: wenxi-zeng

README.md

@@ -185,10 +185,10 @@ The screen call lets you record whenever a user sees a screen in your mobile app
 
 Method signature:
 ```kotlin
-fun screen(screenTitle: String, properties: JsonObject = emptyJsonObject, category: String = "")
+fun screen(title: String, properties: JsonObject = emptyJsonObject, category: String = "")
 
 // If <T> is annotated with @Serializable you will not need to provide a serializationStrategy
-fun <T> screen(screenTitle: String, properties: T, category: String = "", serializationStrategy: KSerializer<T>)
+fun <T> screen(title: String, properties: T, category: String = "", serializationStrategy: KSerializer<T>)
 ```
 
 Example Usage:

core/src/main/java/com/segment/analytics/kotlin/core/Analytics.kt

@@ -201,18 +201,18 @@ class Analytics(val configuration: Configuration) : Subscriber {
      * attach a name, category or properties to the screen. Either category or name must be
      * provided.
      *
-     * @param screenTitle A name for the screen.
+     * @param title A name for the screen.
      * @param category A category to describe the screen.
      * @param properties [Properties] to add extra information to this call.
      * @see <a href="https://segment.com/docs/spec/screen/">Screen Documentation</a>
      */
     @JvmOverloads
     fun screen(
-        screenTitle: String,
+        title: String,
         properties: JsonObject = emptyJsonObject,
         category: String = ""
     ) {
-        val event = ScreenEvent(name = screenTitle, category = category, properties = properties)
+        val event = ScreenEvent(name = title, category = category, properties = properties)
         process(event)
     }
 
@@ -221,20 +221,20 @@ class Analytics(val configuration: Configuration) : Subscriber {
      * attach a name, category or properties to the screen. Either category or name must be
      * provided.
      *
-     * @param screenTitle A name for the screen.
+     * @param title A name for the screen.
      * @param category A category to describe the screen.
      * @param properties [Properties] to add extra information to this call. Needs to be [serializable](https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/serializers.md)
      * @param serializationStrategy strategy to serialize [properties]
      * @see <a href="https://segment.com/docs/spec/screen/">Screen Documentation</a>
      */
     fun <T : Any> screen(
-        screenTitle: String,
+        title: String,
         properties: T,
         serializationStrategy: SerializationStrategy<T>,
         category: String = ""
     ) {
         screen(
-            screenTitle,
+            title,
             Json.encodeToJsonElement(serializationStrategy, properties).jsonObject,
             category
         )
@@ -245,17 +245,17 @@ class Analytics(val configuration: Configuration) : Subscriber {
      * attach a name, category or properties to the screen. Either category or name must be
      * provided.
      *
-     * @param screenTitle A name for the screen.
+     * @param title A name for the screen.
      * @param category A category to describe the screen.
      * @param properties [Properties] to add extra information to this call. Needs to be [serializable](https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/serializers.md)
      * @see <a href="https://segment.com/docs/spec/screen/">Screen Documentation</a>
      */
     inline fun <reified T : Any> screen(
-        screenTitle: String,
+        title: String,
         properties: T,
         category: String = "",
     ) {
-        screen(screenTitle, properties, Json.serializersModule.serializer(), category)
+        screen(title, properties, Json.serializersModule.serializer(), category)
     }
 
     /**

core/src/test/kotlin/com/segment/analytics/kotlin/core/AnalyticsTests.kt

@@ -258,7 +258,7 @@ class AnalyticsTests {
                 val mockPlugin = spyk(StubPlugin())
                 analytics.add(mockPlugin)
                 analytics.screen(
-                    screenTitle = "main",
+                    title = "main",
                     category = "mobile",
                     properties = buildJsonObject { put("foo", "bar") })
                 val screen = slot<ScreenEvent>()