diff --git a/README.md b/README.md index ed66473e..b6287ee3 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,8 @@ as the native (AOSP) Android Contacts app and Google Contacts app, this library ## Quick links - 📜 [Documentation][github-pages] -- 🚉 [Current release - 0.2.3](https://github.com/vestrel00/contacts-android/releases/tag/0.2.3) -- 🚂 [Upcoming release - 0.2.4](https://github.com/vestrel00/contacts-android/discussions/248) +- 🚉 [Current release - 0.2.4](https://github.com/vestrel00/contacts-android/releases/tag/0.2.4) +- 🚂 [Upcoming release - 0.3.0](https://github.com/vestrel00/contacts-android/discussions/218) - đŸ—ē [Project roadmap][project-roadmap] - 💌 [Why use this library?][why-use-this] @@ -132,18 +132,18 @@ To install individual modules, ```groovy dependencies { - implementation 'com.github.vestrel00.contacts-android:core:0.2.3' + implementation 'com.github.vestrel00.contacts-android:core:0.2.4' - implementation 'com.github.vestrel00.contacts-android:async:0.2.3' - implementation 'com.github.vestrel00.contacts-android:customdata-gender:0.2.3' - implementation 'com.github.vestrel00.contacts-android:customdata-googlecontacts:0.2.3' - implementation 'com.github.vestrel00.contacts-android:customdata-handlename:0.2.3' - implementation 'com.github.vestrel00.contacts-android:customdata-pokemon:0.2.3' - implementation 'com.github.vestrel00.contacts-android:customdata-rpg:0.2.3' - implementation 'com.github.vestrel00.contacts-android:debug:0.2.3' - implementation 'com.github.vestrel00.contacts-android:permissions:0.2.3' - implementation 'com.github.vestrel00.contacts-android:test:0.2.3' - implementation 'com.github.vestrel00.contacts-android:ui:0.2.3' + implementation 'com.github.vestrel00.contacts-android:async:0.2.4' + implementation 'com.github.vestrel00.contacts-android:customdata-gender:0.2.4' + implementation 'com.github.vestrel00.contacts-android:customdata-googlecontacts:0.2.4' + implementation 'com.github.vestrel00.contacts-android:customdata-handlename:0.2.4' + implementation 'com.github.vestrel00.contacts-android:customdata-pokemon:0.2.4' + implementation 'com.github.vestrel00.contacts-android:customdata-rpg:0.2.4' + implementation 'com.github.vestrel00.contacts-android:debug:0.2.4' + implementation 'com.github.vestrel00.contacts-android:permissions:0.2.4' + implementation 'com.github.vestrel00.contacts-android:test:0.2.4' + implementation 'com.github.vestrel00.contacts-android:ui:0.2.4' // Notice that when importing specific modules/subprojects, the first ":" comes after "contacts-android". } ``` @@ -154,7 +154,7 @@ To install all modules in a single line, ```groovy dependencies { - implementation 'com.github.vestrel00:contacts-android:0.2.3' + implementation 'com.github.vestrel00:contacts-android:0.2.4' // Notice that when importing all modules, the first ":" comes after "vestrel00". } ``` diff --git a/docs/basics/include-only-desired-data.md b/docs/basics/include-only-desired-data.md index 59962abf..a6cf770b 100644 --- a/docs/basics/include-only-desired-data.md +++ b/docs/basics/include-only-desired-data.md @@ -100,9 +100,9 @@ val contacts = Contacts(context) takes between 99 to 144 **milliseconds** =) -> ℹī¸ As of [version 0.2.4](https://github.com/vestrel00/contacts-android/discussions/248), including -> only fields from `Fields.Contact` in `Query` and `BroadQuery` API calls will result in the -> fastest and most memory efficient queries. Prior versions do not have this extra optimization, +> ℹī¸ As of [version 0.2.4](https://github.com/vestrel00/contacts-android/releases/tag/0.2.4), +> including only fields from `Fields.Contact` in `Query` and `BroadQuery` API calls will result in +> the fastest and most memory efficient queries. Prior versions do not have this extra optimization, > though including less fields still result in faster queries. Prior versions will take on average > 1334 milliseconds for the same query above. diff --git a/docs/basics/limit-and-offset-queries.md b/docs/basics/limit-and-offset-queries.md index bfe33c0c..3481c7ff 100644 --- a/docs/basics/limit-and-offset-queries.md +++ b/docs/basics/limit-and-offset-queries.md @@ -33,7 +33,7 @@ number of entities returned exceed the `limit`. Setting `forceOffsetAndLimit(true)` will ensure that the `offset` and `limit will be applied after performing the internal database query, before returning the result to the caller (you). -> ℹī¸ The `forceOffsetAndLimit` is available since [version 0.2.4](https://github.com/vestrel00/contacts-android/discussions/248). +> ℹī¸ The `forceOffsetAndLimit` is available since [version 0.2.4](https://github.com/vestrel00/contacts-android/releases/tag/0.2.4). This defaults to true in order to seamlessly support pagination. However, it is recommended to set this to false and handle such cases yourself to prevent performing more than one query for devices diff --git a/docs/entities/about-local-contacts.md b/docs/entities/about-local-contacts.md index 5508aa65..f88570b9 100644 --- a/docs/entities/about-local-contacts.md +++ b/docs/entities/about-local-contacts.md @@ -91,6 +91,6 @@ query.accounts(null) When a null is provided, all query APIs will internally additionally add `Account("vnd.sec.contact.phone", "vnd.sec.contact.phone")`. -> ⚠ī¸ This internal fix is available as of [version 0.2.4](https://github.com/vestrel00/contacts-android/discussions/248). +> ⚠ī¸ This internal fix is available as of [version 0.2.4](https://github.com/vestrel00/contacts-android/releases/tag/0.2.4). > Prior versions will require you to pass in `Account("vnd.sec.contact.phone", "vnd.sec.contact.phone")` > in addition to `null` when using `accounts` for matching local contacts. \ No newline at end of file