diff --git a/README.md b/README.md index bc188f6f7d9f25b02379e9c0e7bac909199ae47f..c34c52b86a12b2c23ee4ecc7bfbc3d7659a67339 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,14 @@ -# Tahoe-CHK +# GBS-Downloader ## What is it? -Tahoe-CHK is a Haskell implementation of the [Tahoe-LAFS](https://tahoe-lafs.org/) CHK crytographic protocol. +GBS-Downloader integrates Tahoe-CHK with Tahoe-Great-Black-Swamp to support downloading and decoding data from Great Black Swamp servers. It aims for bit-for-bit compatibility with the original Python implementation. -It will not include an implementation of any network protocol for transferring CHK shares. -However, its APIs are intended to be easy to integrate with such an implementation. - ### What is the current state? -* Convergent encryption is supported and compatible with Tahoe-LAFS. -* CHK encoding is implemented but some cases are unsupported: - * It is not allowed that k == 1 or k == n. -* CHK decoding is implemented with the same limitations as for encoding. - * Authenticity of the decoded data is not yet verified. +It's just starting. +It can't do much. ## Why does it exist? diff --git a/flake.nix b/flake.nix index c767337702014cc4fe17cc1b6f867f0ac19f098a..3b0f855eaf5d60d691d08acae679b279af7a7463 100644 --- a/flake.nix +++ b/flake.nix @@ -1,5 +1,5 @@ { - description = "tahoe-downloader"; + description = "gbs-downloader"; inputs = { # Nix Inputs @@ -26,7 +26,7 @@ inherit pkgs; src = ./.; compilerVersion = ghcVersion; - packageName = "tahoe-downloader"; + packageName = "gbs-downloader"; }; in { checks = hslib.checks {}; @@ -46,7 +46,7 @@ text = '' cabal update hackage.haskell.org cabal build --enable-tests - eval "$(cabal list-bin tahoe-chk-tests)" + eval "$(cabal list-bin gbs-downloader-tests)" ''; } }/bin/cabal-build-and-test";