Update Readme

Author: pithu

README.md

@@ -10,6 +10,7 @@
 
 ## Motivation
 
+Implementation of the js-joda ZoneRulesProvider, providing the 
 bindings to the iana tzdb, using latest zone file generated by moment-timezone
 
 ## Usage
@@ -19,19 +20,29 @@ bindings to the iana tzdb, using latest zone file generated by moment-timezone
 Install joda using npm
 
     npm install js-joda
+    npm install js-joda-timezone
 
-Then require it 
+Require it 
 
     jsJoda = require('js-joda')
         .use(require('js-joda-timezone'))
 
     const {LocalDateTime, ZoneId, ZonedDateTime } = jsJoda;
-    
-    const zone = ZoneId.of('Europe/Berlin')
-    const zdt = LocalDateTime.parse('2016-06-30T11:30').atZone(zone) // 2016-06-30T11:30+02:00[Europe/Berlin]
-    ZonedDateTime.parse('2016-06-30T11:30+02:00[Europe/Berlin]')     // 2016-06-30T11:30+02:00[Europe/Berlin]
-    zdt.withZoneSameInstant(ZoneId.of('America/New_York')) // 2016-06-30T05:30-04:00[America/New_York]
-    zdt.withZoneSameLocal(ZoneId.of('America/New_York'))   // 2016-06-30T11:30-04:00[America/New_York]
+         
+    LocalDateTime
+        .parse('2016-06-30T11:30')
+        .atZone(ZoneId.of('Europe/Berlin'))
+        .toString()  // 2016-06-30T11:30+02:00[Europe/Berlin]
+         
+    ZonedDateTime
+        .parse('2016-06-30T11:30+02:00[Europe/Berlin]') 
+        .withZoneSameInstant(ZoneId.of('America/New_York'))
+        .toString() // 2016-06-30T05:30-04:00[America/New_York]
+
+    ZonedDateTime
+        .parse('2016-06-30T11:30+02:00[Europe/Berlin]')
+        .withZoneSameLocal(ZoneId.of('America/New_York'))
+        .toString() // 2016-06-30T11:30-04:00[America/New_York]
 
 ### Browser
 
@@ -43,34 +54,35 @@ Then require it
 
         // copy all js-joda classes to the global scope
         for(let key in JSJoda) { this[key] = JSJoda[key]; }
-
-        const zone = ZoneId.of('Europe/Berlin')
-        let zdt = LocalDateTime.parse('2016-06-30T11:30').atZone(zone)
-        console.log(zdt.toString()) // 2016-06-30T11:30+02:00[Europe/Berlin]
-
-        zdt = ZonedDateTime.parse('2016-06-30T11:30+02:00[Europe/Berlin]')
-        console.log(zdt.toString()) // 2016-06-30T11:30+02:00[Europe/Berlin]
-
-        zdtl = zdt.withZoneSameInstant(ZoneId.of('America/New_York'))
-        console.log(zdtl.toString())  // 2016-06-30T05:30-04:00[America/New_York]
-
-        zdti = zdt.withZoneSameLocal(ZoneId.of('America/New_York'))
-        console.log(zdti.toString()) // 2016-06-30T11:30-04:00[America/New_York]
+            
+        LocalDateTime
+            .parse('2016-06-30T11:30')
+            .atZone(ZoneId.of('Europe/Berlin'))
+            .toString()  // 2016-06-30T11:30+02:00[Europe/Berlin]
+             
+        ZonedDateTime
+            .parse('2016-06-30T11:30+02:00[Europe/Berlin]') 
+            .withZoneSameInstant(ZoneId.of('America/New_York'))
+            .toString() // 2016-06-30T05:30-04:00[America/New_York]
+    
+        ZonedDateTime
+            .parse('2016-06-30T11:30+02:00[Europe/Berlin]')
+            .withZoneSameLocal(ZoneId.of('America/New_York'))
+            .toString() // 2016-06-30T11:30-04:00[America/New_York]
     </script>
 
 ## Known Issues
 
-The package is incomplete, has pure test coverage and work is in progress.
-
-* ZoneDateTime methods should work correctly, except for calculations during a daylight saving 
-  transition
-* LocalDate.atStartOfDay(zone) might return wrong date if the start of day is within a daylight saving 
-  transition. (very rare case like at gaza)
-* ZoneRules only implement methods that are required by js-joda core, there is still functionality missing
-* other ZoneRules methods (like standardOffset) are not supported  
+* This ZoneRulesProvider implemantion supplies all functionality that is required from the js-joda core 
+library. 
+* Additional ZoneRules functionality like get all transitions, etc is not implemented.
 
 ## License
 
-+ js-joda-timezone is released under the [BSD 3-clause license](LICENSE):
+* js-joda-timezone is released under the [BSD 3-clause license](LICENSE):
+
+* The author of joda time and the lead architect of the JSR-310 is Stephen Colebourne.
+
+* The packed json version of the iana tzdb is imported from [moment-timezone](https://github.com/moment/moment-timezone) package.   
+
 
-+ The author of joda time and the lead architect of the JSR-310 is Stephen Colebourne.