<NME> README.md
<BEF> joda-time-android
=================

This library is a version of [Joda-Time](https://github.com/JodaOrg/joda-time) built with Android in mind.

Usage
=====

Currently, the only way to use it is to import it into your project as a library.  Coming soon: apklib/aar support.

Once it's building, you will need to initialize the timezone provider (via `ResourceZoneInfoProvider.init()`) before you can start using DateTime objects.  I suggest putting this code in `Application.onCreate()`:

    ResourceZoneInfoProvider.init(this);


I know what you are thinking: Joda-Time is a great library and it's just a single JAR, so why make things more complex by wrapping it in an Android library?

Android has built-in date and time handling - why bother with a library?  If you've worked with Java's Date and Calendar classes you can probably answer this question yourself, but if not, check out [Joda-Time's list of benefits](http://www.joda.org/joda-time/#Why_Joda-Time).

For Android developers in particular Joda-Time solves one critical problem: stale timezone data.  Built-in timezone data is only updated when the OS is updated, and we all know how often that happens for most devices.  [Countries modify their timezones all the time](http://www.bbc.co.uk/news/world-europe-15512177); being able to update your own data keeps your app accurate on all devices.

Why This Library?
=================

I know what you are thinking: Joda-Time is a great library and it's just a single JAR, so why make things more complex by wrapping it in an Android library?

There is a particular problem with the JAR setup on Android: due to its usage of [ClassLoader.getResourceAsStream()](http://developer.android.com/reference/java/lang/ClassLoader.html#getResourceAsStream%28java.lang.String%29), it greatly inflates its memory footprint on apps.  (For more details, see [this blog post](http://daniel-codes.blogspot.com/2013/08/joda-times-memory-issue-in-android.html).)  This library avoids the problem for Android by loading from resources instead of a JAR.

We also have the opportunity to improve Joda-Time usage for the Android platform (such as implementing Parcelable for classes).
dependencies {
    implementation 'net.danlew:android.joda:2.12.1'
}
```

Multi-Process Apps
===============

Due to using App Startup, joda-time-android will not automatically initialize in non-main processes.

If you would like to automatically run App Startup in other processes, add this to your manifest:

```xml
<provider
    android:name="androidx.startup.InitializationProvider"
    android:authorities="${applicationId}.androidx-startup"
    android:exported="false"
    android:process="[your-process-name-here]"
    tools:node="merge" />
```

Alternatively, you can call [`AppInitializer`](https://developer.android.com/reference/kotlin/androidx/startup/AppInitializer) directly to initialize just joda-time-android:

```kotlin
AppInitializer.getInstance(this).initializeComponent(JodaTimeInitializer::class.java)
```

Troubleshooting
===============
__Q: My build fails with an error about a duplicate file__

> Duplicate files copied in APK META-INF/LICENSE.txt

or

> Duplicate files copied in APK META-INF/NOTICE.txt

__A: We can safely exclude those files from our build. You need to specify these two `exclude`s in your `build.gradle` file and you will be good to go:__

```
android {
    ...
    packagingOptions {
        exclude 'META-INF/LICENSE.txt'
        exclude 'META-INF/NOTICE.txt'
    }
}
```

or 

__B: We can safely choose to add those files to our build. You need to specify these two `merge`s in your `build.gradle` file and you will be good to go:__

```
android {
    ...
    packagingOptions {
        merge '**/LICENSE.txt'
        merge '**/NOTICE.txt'
    }
}
```

<MSG> Updated README

<DFF> @@ -6,9 +6,9 @@ This library is a version of [Joda-Time](https://github.com/JodaOrg/joda-time) b
 Usage
 =====
 
-Currently, the only way to use it is to import it into your project as a library.  Coming soon: apklib/aar support.
+Currently, the only way to use it is to import it into your project as a library.  Coming soon: aar support.
 
-Once it's building, you will need to initialize the timezone provider (via `ResourceZoneInfoProvider.init()`) before you can start using DateTime objects.  I suggest putting this code in `Application.onCreate()`:
+You will need to initialize the timezone provider (via `ResourceZoneInfoProvider.init()`) before you can start using this library.  I suggest putting this code in `Application.onCreate()`:
 
     ResourceZoneInfoProvider.init(this);
 
@@ -17,13 +17,11 @@ Why Joda-Time?
 
 Android has built-in date and time handling - why bother with a library?  If you've worked with Java's Date and Calendar classes you can probably answer this question yourself, but if not, check out [Joda-Time's list of benefits](http://www.joda.org/joda-time/#Why_Joda-Time).
 
-For Android developers in particular Joda-Time solves one critical problem: stale timezone data.  Built-in timezone data is only updated when the OS is updated, and we all know how often that happens for most devices.  [Countries modify their timezones all the time](http://www.bbc.co.uk/news/world-europe-15512177); being able to update your own data keeps your app accurate on all devices.
+For Android developers in particular Joda-Time solves one critical problem: stale timezone data.  Built-in timezone data is only updated when the OS is updated, and we all know how often that happens.  [Countries modify their timezones all the time](http://www.bbc.co.uk/news/world-europe-15512177); being able to update your own data keeps your app up-to-date and accurate.
 
 Why This Library?
 =================
 
 I know what you are thinking: Joda-Time is a great library and it's just a single JAR, so why make things more complex by wrapping it in an Android library?
 
-There is a particular problem with the JAR setup on Android: due to its usage of [ClassLoader.getResourceAsStream()](http://developer.android.com/reference/java/lang/ClassLoader.html#getResourceAsStream%28java.lang.String%29), it greatly inflates its memory footprint on apps.  (For more details, see [this blog post](http://daniel-codes.blogspot.com/2013/08/joda-times-memory-issue-in-android.html).)  This library avoids the problem for Android by loading from resources instead of a JAR.
-
-We also have the opportunity to improve Joda-Time usage for the Android platform (such as implementing Parcelable for classes).
\ No newline at end of file
+There is a particular problem with the JAR setup on Android: due to its usage of [ClassLoader.getResourceAsStream()](http://developer.android.com/reference/java/lang/ClassLoader.html#getResourceAsStream%28java.lang.String%29), it greatly inflates its memory footprint on apps.  (For more details, see [this blog post](http://daniel-codes.blogspot.com/2013/08/joda-times-memory-issue-in-android.html).)  This library avoids the problem for Android by loading from resources instead of a JAR.
\ No newline at end of file

Updated README