From f7d885529d704e0dce9708ae2e9c06baee33f7e8 Mon Sep 17 00:00:00 2001 From: Bryan Newbold Date: Fri, 11 Nov 2022 17:46:33 -0800 Subject: update README and TODO a bit --- README.md | 12 ++++++++++-- TODO | 9 ++++----- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 28989cc..b498346 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,19 @@ goal is to think through how the protocol might work by implementing it. Components: -- `adenosine-cli` ([README](./adenosine-cli/README.md): command-line client (`adenosine`) -- `adenosine-pds` ([README](./adenosine-pds/README.md): "small world" personal data server implementation, with data in sqlite +- `adenosine-cli` ([README](./adenosine-cli/README.md), [manpage](./extra/adenosine.1.md)): command-line client (`adenosine`) +- `adenosine-pds` ([README](./adenosine-pds/README.md), [manpage](./extra/adenosine-pds.1.md)): "small world" personal data server implementation, with data in sqlite +## Disclaimer +In addition to the below standard Free Software disclaimer from the LICENSE +file, note that this project is likely to be out of sync with upstream protocol +specifications; is not intended for real-world use; is entirely naive about +abuse, security, and privacy; will not have an upgrade/migration path; etc. +> [CONTRIBUTORS] PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, > +> EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED > +> WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. ## Development and Contributions diff --git a/TODO b/TODO index 61a1b0c..139e768 100644 --- a/TODO +++ b/TODO @@ -1,5 +1,5 @@ -CLI polish: +CLI: - register and login commands should do more than just dump JSON => return shell 'export' command (for easier config) - log (info level) all XRPC requests and responses. especially non-200 response bodies @@ -12,10 +12,9 @@ CLI polish: - update top-level README => badges: AGPL, CI -later: -- mention IPFS exploration of export CAR files -- invite codes in account registration -- try musl/rustls builds, especially for CLI + +packaging/deployment: +- try musl/rustls builds https://burgers.io/cross-compile-rust-from-arm-to-x86-64 rustup target add x86_64-unknown-linux-musl cargo build --release --target=x86_64-unknown-linux-musl -- cgit v1.2.3