diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2010 Yitzchak Gale. All rights reserved. +Copyright (c) 2010-2015 Yitzchak Gale. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are diff --git a/README b/README deleted file mode 100644 --- a/README +++ /dev/null @@ -1,62 +0,0 @@ -timezone-series version 0.1.0 - -This package endows Data.Time, from the time package, with several -additional data types for enhanced processing of timezones. - -A TimeZoneSeries represents a timezone. It describes the timezone with -a set of Data.Time.TimeZone objects, each describing the clock setting -in the timezone for a specific period of history during which the -clocks do not change. The TimeZoneSeries as a whole describes what -clock setting was in effect in the timezone at any given time during -the period it covers. - -A ZoneSeriesTime is a moment in time within a specific timezone. It -is different than a Data.Time.ZonedTime in that a ZonedTime specifies -a moment in time for a specific way that the clocks were set in a -timezone. It is the responsibilty of the creator of a ZonedTime to -verify that given clock setting was actually in effect at the given -moment in time. A ZonedTime for one moment in time cannot be used -reliably on its own to create another ZonedTime for a different moment -in the same timezone - information is needed about what clock setting -was in effect in the timezone at the new moment. - -This package also provides variants for the functions in Data.Time -that convert between UTC time and local time. These variants take -a TimeZoneSeries, representing a timezone, not just a specific -clock setting with the timezone, so the correctness of their results -does not depend on independent knowledge of what clock setting -was in effect at the given time. - -Most operating systems provide information about timezone series for -the local timezone and for many other timezones of the world. On MS -Windows systems, this information can be read from the registry. On -other systems, this information is typically provided in the form of -Olson timezone files: /etc/localtime (or some other file) for the -local timezone, and files located in /usr/share/zoneinfo/ or -/etc/zoneinfo/ (or some other directory) for other timezones. -See the timezone-olson package for more information about reading -and creating Olson timezone files. - -This version of timezone-series is highly experimental. Expect there -to be bugs, and do not rely on any stability of the exposed -interfaces. - -Copyright (c) 2010 Yitzchak Gale. All rights reserved. -For licensing information, see the BSD3-style license in the file -LICENSE that was originally distributed by the author together with -this file. - -This package is part of the time-ng project: -http://projects.haskell.org/time-ng/ - -Send suggestions, bug reports, and patches to: -yitz@community.haskell.org - -INSTALLATION: - -To install the latest version of this package, make sure that -cabal-install is installed on your system (it is if you have installed -the Haskell Platform) and type the commands: - -cabal update -cabal install timezone-series diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ += timezone-series = + +On Hackage: [timezone-series](http://hackage.haskell.org/package/timezone-series) + +This package endows Data.Time, from the time package, with several +additional data types for enhanced processing of timezones. + +A TimeZoneSeries represents a timezone. It describes the timezone with +a set of Data.Time.TimeZone objects, each describing the clock setting +in the timezone for a specific period of history during which the +clocks do not change. The TimeZoneSeries as a whole describes what +clock setting was in effect in the timezone at any given time during +the period it covers. + +A ZoneSeriesTime is a moment in time within a specific timezone. It +is different than a Data.Time.ZonedTime in that a ZonedTime specifies +a moment in time for a specific way that the clocks were set in a +timezone. It is the responsibilty of the creator of a ZonedTime to +verify that given clock setting was actually in effect at the given +moment in time. A ZonedTime for one moment in time cannot be used +reliably on its own to create another ZonedTime for a different moment +in the same timezone - information is needed about what clock setting +was in effect in the timezone at the new moment. + +This package also provides variants for the functions in Data.Time +that convert between UTC time and local time. These variants take +a TimeZoneSeries, representing a timezone, not just a specific +clock setting with the timezone, so the correctness of their results +does not depend on independent knowledge of what clock setting +was in effect at the given time. + +Most operating systems provide information about timezone series for +the local timezone and for many other timezones of the world. On MS +Windows systems, this information can be read from the registry. On +other systems, this information is typically provided in the form of +Olson timezone files: /etc/localtime (or some other file) for the +local timezone, and files located in /usr/share/zoneinfo/ or +/etc/zoneinfo/ (or some other directory) for other timezones. +See the timezone-olson timezone-olson-th packages for more information +about reading and creating Olson timezone files. + +http://hackage.haskell.org/package/timezone-olson +http://hackage.haskell.org/package/timezone-olson-th + +Copyright (c) 2010-2015 Yitzchak Gale. All rights reserved. + +For licensing information, see the BSD3-style license in the file +LICENSE that was originally distributed by the author together with +this file. + +This package is part of the [time-ng project](http://projects.haskell.org/time-ng/). diff --git a/timezone-series.cabal b/timezone-series.cabal --- a/timezone-series.cabal +++ b/timezone-series.cabal @@ -1,28 +1,31 @@ Name: timezone-series -Version: 0.1.4 +Version: 0.1.5 Synopsis: Enhanced timezone handling for Data.Time Description: This package endows Data.Time, from the time package, with several data types and functions for enhanced processing of timezones. For one way to create timezone series, see the timezone-olson - package. + (http://hackage.haskell.org/package/timezone-olson) + and timezone-olson-th + (http://hackage.haskell.org/package/timezone-olson-th) + packages. Homepage: http://projects.haskell.org/time-ng/ License: BSD3 License-file: LICENSE Author: Yitzchak Gale Maintainer: yitz@sefer.org -Copyright: Copyright (c) 2010-2014 Yitzchak Gale. All rights reserved. +Copyright: Copyright (c) 2010-2015 Yitzchak Gale. All rights reserved. Category: Data Build-type: Simple -Extra-source-files: README +Extra-source-files: README.md Cabal-version: >=1.10 Source-repository HEAD - type: darcs - location: http://code.haskell.org/time-ng/timezone-series + type: git + location: https://github.com/ygale/timezone-series.git Library Default-language: Haskell2010 Exposed-modules: Data.Time.LocalTime.TimeZone.Series Default-extensions: DeriveDataTypeable Build-depends: base >= 4.4 && < 5, - time >= 1.1.4 && < 1.5 + time >= 1.1.4 && < 1.6