From c1315e5c839975a5f0e69403b7a596f025f86406 Mon Sep 17 00:00:00 2001 From: Jordan Mackie Date: Mon, 30 Nov 2020 09:07:50 +0000 Subject: [PATCH] Final tweaks before uploading --- CHANGELOG.md | 4 ++-- README.md | 13 ++++++++++++- kesha.cabal | 2 +- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ebddda..f3dbbbf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,8 +3,8 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +and this project adheres to the [Haskell Package Versioning Policy](https://pvp.haskell.org/). -## [0.1.0] - 2020-11-29 +## [0.1.0.0] - 2020-11-29 First cabal release 🎉🥳 diff --git a/README.md b/README.md index 40489b1..59f37e2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # `kesha` [![CI](https://github.com/jmackie/kesha/workflows/CI/badge.svg)](https://github.com/jmackie/kesha/actions?query=workflow%3ACI) -[![Hackage](https://img.shields.io/hackage/v/kesha-0.1.0)](https://hackage.haskell.org/package/kesha-0.1.0/candidate) +[![Hackage](https://img.shields.io/hackage/v/kesha)](https://hackage.haskell.org/package/kesha) A Haskell library for computing the cryptographic hash of any path. The implementation is an almost verbatim implementation of `nix-hash`, which is the standard tool used by the [Nix](https://nixos.org/nix/) package manager. + +```haskell +module Main where + +import qualified Kesha + +main :: IO () +main = do + result <- Kesha.hash "some-path" + print result +``` diff --git a/kesha.cabal b/kesha.cabal index a8dae9f..f3906e7 100644 --- a/kesha.cabal +++ b/kesha.cabal @@ -1,7 +1,7 @@ cabal-version: >= 1.10 name: kesha -version: 0.1.0 +version: 0.1.0.0 synopsis: Haskell implementation of nix-hash description: Compute the cryptographic hash of a path, à la . homepage: https://github.com/jmackie/kesha