From c01d2718e9b48e262fb29e5e6146fe3bf1ef7508 Mon Sep 17 00:00:00 2001 From: sorki Date: Wed, 31 Jul 2024 16:39:44 +0200 Subject: [PATCH] Add new packages to toplevel README Closes #245 --- README.md | 48 ++++++++++++++++++++++++++++--- hnix-store-db/hnix-store-db.cabal | 2 +- 2 files changed, 45 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 33eab84e..d49fe027 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # hnix-store +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/haskell-nix/hnix-store/ci.yaml?branch=master)](https://github.com/haskell-nix/hnix-store/actions/workflows/ci.yaml) + A Haskell interface to the [Nix] store. [Nix]: https://nixos.org/nix @@ -44,12 +46,11 @@ several Haskell packages. ### [hnix-store-core] -[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/haskell-nix/hnix-store/ci.yaml?branch=master)](https://github.com/haskell-nix/hnix-store/actions/workflows/ci.yaml) [![Hackage version](https://img.shields.io/hackage/v/hnix-store-core.svg?color=success)](https://hackage.haskell.org/package/hnix-store-core) [![Dependencies](https://img.shields.io/hackage-deps/v/hnix-store-core?label=Dependencies)](https://packdeps.haskellers.com/feed?needle=hnix-store-core) -Contains the core effect types and -fundamental operations combining them, agnostic to any particular +Contains the core types and +fundamental operations, agnostic to any particular effectful implementation (e.g. in-memory, talking to the Nix daemon in IO, etc.), with the actual implementations in a different package. @@ -58,14 +59,53 @@ interact with the `Nix` store can simply depend on `hnix-store-core`, and only at the very edges of the system would it be necessary to bring in a specific implementation. +### [hnix-store-db] + +[![Hackage version](https://img.shields.io/hackage/v/hnix-store-db.svg?color=success)](https://hackage.haskell.org/package/hnix-store-db) +[![Dependencies](https://img.shields.io/hackage-deps/v/hnix-store-db?label=Dependencies)](https://packdeps.haskellers.com/feed?needle=hnix-store-db) + +Implementation of the `Nix` store SQLite database. + +### [hnix-store-json] + +[![Hackage version](https://img.shields.io/hackage/v/hnix-store-json.svg?color=success)](https://hackage.haskell.org/package/hnix-store-json) +[![Dependencies](https://img.shields.io/hackage-deps/v/hnix-store-json?label=Dependencies)](https://packdeps.haskellers.com/feed?needle=hnix-store-json) + +`Aeson` instances for core types, required for remote store protocol. + +### [hnix-store-nar] + +[![Hackage version](https://img.shields.io/hackage/v/hnix-store-nar.svg?color=success)](https://hackage.haskell.org/package/hnix-store-nar) +[![Dependencies](https://img.shields.io/hackage-deps/v/hnix-store-nar?label=Dependencies)](https://packdeps.haskellers.com/feed?needle=hnix-store-nar) + +Packing and unpacking for NAR file format used by Nix. + +### [hnix-store-readonly] + +[![Hackage version](https://img.shields.io/hackage/v/hnix-store-readonly.svg?color=success)](https://hackage.haskell.org/package/hnix-store-readonly) +[![Dependencies](https://img.shields.io/hackage-deps/v/hnix-store-readonly?label=Dependencies)](https://packdeps.haskellers.com/feed?needle=hnix-store-readonly) + +Path computation without interaction with the actual `Nix` store + ### [hnix-store-remote] -[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/haskell-nix/hnix-store/ci.yaml?branch=master)](https://github.com/haskell-nix/hnix-store/actions/workflows/ci.yaml) [![Hackage version](https://img.shields.io/hackage/v/hnix-store-remote.svg?color=success)](https://hackage.haskell.org/package/hnix-store-remote) [![Dependencies](https://img.shields.io/hackage-deps/v/hnix-store-remote?label=Dependencies)](https://packdeps.haskellers.com/feed?needle=hnix-store-remote) [Nix] worker protocol implementation for interacting with remote Nix store via `nix-daemon`. +### [hnix-store-tests] + +[![Hackage version](https://img.shields.io/hackage/v/hnix-store-tests.svg?color=success)](https://hackage.haskell.org/package/hnix-store-tests) +[![Dependencies](https://img.shields.io/hackage-deps/v/hnix-store-tests?label=Dependencies)](https://packdeps.haskellers.com/feed?needle=hnix-store-tests) + +Aribtrary instances and utilities for testing. + [hnix-store-core]: ./hnix-store-core +[hnix-store-db]: ./hnix-store-db +[hnix-store-json]: ./hnix-store-json +[hnix-store-nar]: ./hnix-store-nar +[hnix-store-readonly]: ./hnix-store-readonly [hnix-store-remote]: ./hnix-store-remote +[hnix-store-tests]: ./hnix-store-tests diff --git a/hnix-store-db/hnix-store-db.cabal b/hnix-store-db/hnix-store-db.cabal index 04ffce9c..5f14c387 100644 --- a/hnix-store-db/hnix-store-db.cabal +++ b/hnix-store-db/hnix-store-db.cabal @@ -2,7 +2,7 @@ cabal-version: 2.2 name: hnix-store-db version: 0.1.0.0 synopsis: Nix store database support -description: Implementation of the nix store database +description: Implementation of the Nix store database homepage: https://github.com/haskell-nix/hnix-store license: Apache-2.0 license-file: LICENSE