From: Julien Tanguy <julien.tanguy@jhome.fr>
Date: Wed, 6 May 2015 12:07:26 +0000 (+0200)
Subject: Fix haddock and add changelog
X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=a5822779f64dcf42a271df7d0043f6665583ea0a;p=github%2Ffretlink%2Fhmacaroons.git

Fix haddock and add changelog

[ci skip]
---

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..3a8e1eb
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,7 @@
+# Revision history for [hmacaroons](https://github.com/jtanguy/hmacaroons)
+
+## 0.1.0 -- (Current development version)
+
+    * Macaroon creation
+    * Base64 serialization
+    * First party caveats
diff --git a/hmacaroons.cabal b/hmacaroons.cabal
index a2878f2..c26ea19 100644
--- a/hmacaroons.cabal
+++ b/hmacaroons.cabal
@@ -4,48 +4,36 @@ synopsis:            Haskell implementation of macaroons
 description:
   = Macaroons: Pure haskell implementation of macaroons
   #macaroons-pure-haskell-implementation-of-macaroons#
-
+  .
   Macaroons is a pure haskell implementation of macaroons. It aims to
   provide compatibility at a serialized level with the
   <https://github.com/rescrv/libmacaroons reference implementation> and
   the <https://github.com/ecordell/pymacaroons python implementation>
-
+  .
   __WARNING: This library has not been audited by security experts.__
-  __There is no error handling at the moment, everyhting is silently
-  accepted__
-
+  __There is no error handling at the moment, everyhting is silently accepted__
+  .
   It is developed in the purpose of exploration purposes, and would need
   much more attention if it were to be used in production.
-
+  .
   = References
   #references#
-
+  .
   == Papers and articles
   #papers-and-articles#
-
+  .
   -   <http://research.google.com/pubs/pub41892.html Google paper on macaroons>
   -   <https://air.mozilla.org/macaroons-cookies-with-contextual-caveats-for-decentralized-authorization-in-the-cloud/ Macaroons at Mozilla>
   -   <http://hackingdistributed.com/2014/11/23/macaroons-in-hyperdex/ Time for better security in NoSQL>
-
+  .
   == Implementations
   #implementations#
-
+  .
   -   <https://github.com/rescrv/libmacaroons C>
   -   <https://github.com/nitram509/jmacaroons Java>
   -   <https://github.com/nitram509/macaroons.js Node.js>
   -   <https://github.com/ecordell/pymacaroons Python>
   -   <https://github.com/cryptosphere/rust-macaroons.git Rust>
-
-  = TODO
-  #todo#
-
-  -   Third party caveats
-  -   Verify Macaroons
-  -   Discharge Macaroons
-  -   JSON serialization
-  -   Quickcheck tests
-  -   Error handling
-  -   FFI\'s for testing and benchmarking purposes
 license:             BSD3
 license-file:        LICENSE
 author:              Julien Tanguy
@@ -56,6 +44,7 @@ category:            Data
 build-type:          Simple
 extra-source-files:  README.md
                      CONTRIBUTING.md
+                     CHANGELOG
 cabal-version:       >=1.10
 
 source-repository head