README

ChangeLog.md

@@ -1,3 +1,9 @@
 # Changelog for multi-containers
 
-## Unreleased changes
+## 0.1.0.1
+
+- Update README
+
+## 0.1.0.0
+
+- Initial release

README.md

@@ -1 +1,13 @@
 # multi-containers
+
+A library that provides three multimap variants:
+
+- [`Multimap k a`](https://hackage.haskell.org/package/multi-containers/docs/Data-Multimap.html), a multimap where values of each key form a list.
+- [`SetMultimap k a`](https://hackage.haskell.org/package/multi-containers/docs/Data-Multimap-Set.html), a multimap where values of each key form a set.
+- [`Table r c a`](https://hackage.haskell.org/package/multi-containers/docs/Data-Multimap-Table.html), a two dimensional table where
+  values are indexed by row keys and column keys; it is essentially a multimap where values of each key form a map.
+
+For `Multimap` and `SetMultimap`, there's always at least one value associated with each key in the multimap. Upon removing
+the last value of a key, the key itself is removed from the multimap.
+
+For `Table`, similarly, each row key in a table always has at least one value. So does each column key.

multi-containers.cabal

@@ -2,17 +2,17 @@
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: ee8ee976df6098bafd1b84099c480eac4bab9fed793ae074100bd0ab676cdc17
+-- hash: 9da8e5d6bcf046772035130681fc079404a33a3d4d63ac224b441b08ce7e0284
 
 name:           multi-containers
-version:        0.1.0.0
-synopsis:       A few variants of multimaps.
-description:    Please see the README on GitHub at <https://github.com/zliu41/multi-containers#readme>
+version:        0.1.0.1
+synopsis:       A few multimap variants.
+description:    A library that provides a few multimap variants.
 category:       Data Structures
 homepage:       https://github.com/zliu41/multi-containers#readme
 bug-reports:    https://github.com/zliu41/multi-containers/issues
-author:         Ziyang Liu
-maintainer:     [email protected]
+author:         Ziyang Liu <[email protected]>
+maintainer:     Ziyang Liu <[email protected]>
 copyright:      2019 Ziyang Liu
 license:        BSD3
 license-file:   LICENSE

package.yaml

@@ -1,23 +1,23 @@
 name:                multi-containers
-version:             0.1.0.0
+version:             0.1.0.1
 github:              "zliu41/multi-containers"
 license:             BSD3
-author:              "Ziyang Liu"
-maintainer:          "[email protected]"
+author:              "Ziyang Liu <[email protected]>"
+maintainer:          "Ziyang Liu <[email protected]>"
 copyright:           "2019 Ziyang Liu"
 
 extra-source-files:
   - README.md
   - ChangeLog.md
 
 # Metadata used when publishing your package
-synopsis:            A few variants of multimaps.
+synopsis:            A few multimap variants.
 category:            Data Structures
 
 # To avoid duplicated efforts in documentation and dealing with the
 # complications of embedding Haddock markup inside cabal files, it is
 # common to point users to the README.md file.
-description:         Please see the README on GitHub at <https://github.com/zliu41/multi-containers#readme>
+description:         A library that provides a few multimap variants.
 
 dependencies:
   - base >= 4.7 && < 5