homepage: http://github.com/composewell/unicode-data
changelog-type: markdown
hash: e843ab962a63eeb306d5a395630079482ad71e10625dd679e96f6e7d95e45ed8
test-bench-deps: {}
maintainer: streamly@composewell.com
synopsis: Access Unicode character database
changelog: |
  # Changelog

  ## 0.1.0 (Jul 2021)

  * Initial release
basic-deps:
  base: '>=4.7 && <5'
  containers: '>=0.5 && <0.7'
  getopt-generics: '>=0.13 && <0.14'
  streamly: '>=0.8 && <0.9'
  directory: '>=1.3.6 && <1.3.7'
all-versions:
- 0.1.0
author: Composewell Technologies and Contributors
latest: 0.1.0
description-type: markdown
description: |
  # README

  `unicode-data` provides Haskell APIs to efficiently access the unicode
  character database. Performance is the primary goal in the design of
  this package.

  The Haskell data structures are generated programmatically from the
  unicode character database (UCD) files.  The latest unicode version
  supported by this library is 13.0.0.

  This package is far from complete. Currently it supports normalization
  related functions and a few other properties, primarily to support
  `unicode-transforms` package. More properties can be added as needed by
  any other packages or use cases.

  Please see the haddock documentation for reference documentation.

  ## Unicode database version update

  To update the unicode version please update the version number in
  `ucd.sh`.

  To download the unicode database, run `ucd.sh download` from the top
  level directory of the repo to fetch the database in `./ucd`.

  ```
  $ ./ucd.sh download
  ```

  To generate the Haskell data structure files from the downloaded database
  files, run `ucd.sh generate` from the top level directory of the repo.

  ```
  $ ./ucd.sh generate
  ```

  ## Running property doctests

  Temporarily add `QuickCheck` to build depends of library.

  ```
  $ cabal build
  $ cabal-docspec --check-properties --property-variables c
  ```

  ## Licensing

  `unicode-data` is an [open source](https://github.com/composewell/unicode-data)
  project available under a liberal [Apache-2.0 license](LICENSE).

  ## Contributing to Streamly

  As an open project we welcome contributions.
license-name: Apache-2.0

Update from Hackage at 2021-07-08T21:22:10Z
Update from Hackage at 2021-07-08T21:22:10Z
