revault_api 0.3.11-x86_64-linux → 0.3.13-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777e535929596e60f14a408847341bef0b8cfc8692230e8f12d0e7b08c09a743
-  data.tar.gz: 7a375c8d62ebf40aa2f12fa67eb8e18b2dede7c283b9e06da20be11c7c2fcd73
+  metadata.gz: c1fe3afd024c7fe6cdb54b0fe418e8ca9ee5e499610b56a605f7ecb68451207f
+  data.tar.gz: 41f1b5e213b18f9afe3a6d91c71dce2a0c856565af43e93f5c60ac1a29574db8
 SHA512:
-  metadata.gz: eb54db5d33218f587d17129045796ddac4f7034cab8b67eee0ce0b4eb89e7cb0a48dfe0515966d18f60217018838e5070b3146fdf52d41cc1eb607b8ae05629f
-  data.tar.gz: 271841730c5d8cf876a7fc58a283cff6e5347779d9e5f1577de8a33f9b2729f06b39bdda1c0db8e5766373fb63a5513408ba6630d7d252427d8fe5c0eb88ba2b
+  metadata.gz: 795cb1cef186ab985dfab3e8b24e63a05d5c845c1de242afe0eefc00875fc260b92ceef09a3b2f7661457aa7351f57144173ff0038064ffdd3657e014755867f
+  data.tar.gz: 4c68bd4e1394b622410cfd022a4a73a13b8dfee65c411eadb7fa1ab8fe1762940936f0b91d5150be73fbe729b2dc1454c1836294492b6f1ea7b3d8415b525f0a

data/LICENSE

@@ -1,8 +1,8 @@
-Dvault Source Available License 1.0
+reVault Source Available License 1.0
 
 Copyright (c) 2021 OnePub IP Pty Ltd
 
-This license applies to the dvault software and associated documentation files
+This license applies to the reVault software and associated documentation files
 (the "Software").
 
 1. Grant of Rights

data/README.md

@@ -1,46 +1,36 @@
-# reVault / Lockbox
+# reVault
 
-reVault creates portable archives that are secure and compressed.
+reVault is a fast, local toolkit for creating secure portable archives called
+Lockboxes. Each Lockbox is encrypted, compressed, and signed. It can store:
 
-The reVault archives are called 'Lockboxes'.
+* files and directory trees
+* file permissions and symbolic links
+* variables such as API keys
+* forms such as login details
 
-You can think of a Lockbox as a zip file on steriods. 
+Lockboxes are easy to copy, share, and back up, and they do not require a
+hosted service. The engine is designed for speed and effective compression.
+Applications can read, write, and seek within stored files without extracting
+the archive, and recover data from partial corruption.
 
-A Lockbox can be used to store:
-* files
-* directories
-* symlinks
-* file/directory permissions
-* variables
-* forms (collection of variables)
+Read the [reVault manual](https://docs.revault.onepub.dev/) for the quick start,
+core concepts, and security model.
 
+reVault runs on Linux, macOS, and Windows. You can use it through the command
+line interface or through libraries for supported programming languages.
 
-A lockbox is encrypted, compressed and signed using modern encryption and compress
-techniques.
+The main components are:
 
-reVault is designed to be simple and safe to use, avoiding overly complex 
-terminology.
+* `revault_cli` for everyday command line use
+* `revault_lockbox_api` for creating and working with Lockboxes
+* `revault_vault_api` for creating and managing Vaults
 
-reVault works on Linux, Windows and MacOS.
+## The main concepts
 
-reVault ships as a:
-  * cli
-  * apis
-  * libraries for multiple languages
-
-
-
-- `revault_cli`, a CLI for everyday use.
-- `revault_lockbox_api`, for creating lockboxes.
-- `revault_vault_api`, for creating and managing vaults.
-
-Terminology is explicit:
-
-- A **lockbox** is a portable archive and uses the `.lbox` extension.
-- A **key** is used to lock and unlock lockboxes. Keys are more secure than passwords.
-- A **vault** is where we store information about lockboxes such as the keys
-used to open and close a lockbox. The vault also holds a contact list which helps us share 
-lockboxes with other people.
+* A **Lockbox** is a portable archive with the `.lbox` extension.
+* A **key** or password controls who can open a Lockbox.
+* A **Vault** stores local profiles, contacts, keys, and remembered access to
+  Lockboxes.
   
 
 > **Pre-release:** the Rust implementation is currently alpha software. The
@@ -356,8 +346,8 @@ let reopened = Lockbox::open(
 let file = reopened.get_file(&LockboxPath::new("/docs/a.txt")?)?;
 ```
 
-Use `revault_vault_api` for native applications that want the local vault and
-open-cache behavior:
+Use `revault_vault_api` for native applications that want the Vault and
+Session Agent behavior:
 
 ```rust
 use revault_vault_api::{local_vault, SecretString};
@@ -375,10 +365,17 @@ lockbox.commit()?;
 
 ## Documentation
 
+Performance results for Lockbox using the published pure-Rust
+`zstd-complete 0.1.0` crate, compared with encrypted GPG and unencrypted ZIP,
+are documented in the
+[benchmark report](docs/lockbox_gpg_zip_benchmark_2026_08_30.md).
+
+- [reVault manual](https://docs.revault.onepub.dev/): installation, concepts,
+  CLI workflows, language APIs, and operational guidance.
 - [CLI how-to](docs/cli_how_to.md): command examples.
 - [CI/CD with reVault](docs/ci_cd.md): proposed bootstrap and ephemeral CI
   workflow for encrypted deployment secrets.
-- [Lockbox Session Agent](docs/lockbox_session_agent.md): local open cache
+- [Session Agent](docs/lockbox_session_agent.md): temporary Lockbox access
   lifecycle, protocol, and security model.
 - [Archive format](rust/revault_lockbox_api/ARCHIVE_FORMAT.md): lockbox archive details and page
   layout.
@@ -388,6 +385,9 @@ lockbox.commit()?;
 
 ## Development
 
+Follow the [reVault terminology standard](docs/terminology.md) when updating
+the manual, READMEs, CLI help, API guides, or other user-facing material.
+
 Run the Rust checks:
 
 ```bash
@@ -405,13 +405,27 @@ cd rust
 cargo xtask generate-api-docs
 ```
 
+### Release checklist
+
+Before publishing a component:
+
+1. update its version and package README;
+2. regenerate class and method documentation;
+3. run the binding conformance examples;
+4. run the manual validation job;
+5. confirm migration notes and compatibility statements; and
+6. retain the tagged repository documentation as the release snapshot.
+
+For complete procedures, read the [CLI distribution guide](docs/cli_distribution.md)
+and the [binding contribution and release guide](bindings/CONTRIBUTING.md).
+
 ## License
 
-Dvault Source Available License 1.0 - see [LICENSE](LICENSE).
+reVault Source Available License 1.0 - see [LICENSE](LICENSE).
 
 The source remains available for inspection, modification, and redistribution.
 Derivative works must publish their corresponding source code in a publicly
 accessible repository such as GitHub or a similar service. The license also
-restricts third parties from offering dvault, modified dvault, or substantially
-similar dvault-derived functionality as a hosted, managed, or
+restricts third parties from offering reVault, modified reVault, or
+substantially similar reVault-derived functionality as a hosted, managed, or
 network-accessible service without a separate written license.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revault_api
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.13
 platform: x86_64-linux
 authors:
 - OnePub
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-25 00:00:00.000000000 Z
+date: 2026-08-30 00:00:00.000000000 Z
 dependencies: []
 description: Complete class-based reVault lockbox and vault API
 email:
@@ -19,14 +19,14 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-homepage: https://github.com/onepub-dev/reVault
+homepage: https://docs.revault.onepub.dev/
 licenses:
 - Nonstandard
 metadata:
   bug_tracker_uri: https://github.com/onepub-dev/reVault/issues
-  changelog_uri: https://github.com/onepub-dev/reVault/blob/master/bindings/CHANGELOG.md
-  documentation_uri: https://github.com/onepub-dev/reVault/tree/master/docs
-  source_code_uri: https://github.com/onepub-dev/reVault/tree/master/bindings/ruby
+  changelog_uri: https://github.com/onepub-dev/reVault/blob/main/bindings/CHANGELOG.md
+  documentation_uri: https://docs.revault.onepub.dev/
+  source_code_uri: https://github.com/onepub-dev/reVault/tree/main/bindings/ruby
 post_install_message:
 rdoc_options: []
 require_paths: