From 88f656a62320dc80ecbdf3bdbddea1a95c446688 Mon Sep 17 00:00:00 2001 From: Pavlo Liapin Date: Tue, 6 Feb 2024 14:40:48 -0600 Subject: [PATCH] clean up readme --- CONTRIBUTING.md | 3 --- README.md | 5 +++-- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db8c181..98e0d4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,3 @@ This IS a useful comment: ```Ruby x = x + 1 # account for border ``` - -## Slack Community [![Slack Status](https://slack.vault12.com/badge.svg)](https://slack.vault12.com) -We've set up a public slack community [Vault12 Dwellers](https://vault12dwellers.slack.com/). Request an invite by clicking [here](https://slack.vault12.com/). diff --git a/README.md b/README.md index 5dd21c4..ce46bda 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ Sending a file from Alice to Bob follows the following protocol: - **Status**: Either party can check information about files currently on the relay using their `uploadID` and `fileStatus` command. If the relay deletes or refreshes `secret_seed.txt` present during initial `startFileUpload`, all requests for the old `uploadID` will fail. - **Delete**: Either party can delete the file using `uploadID` and the `deleteFile` command. - **Data pruning**: All Redis information about the files expires, with the default set to one week. If a file is not removed with the `deleteFile` command, after Redis expiration, the relay will delete old files via a cleanup job. The cleanup job will also delete files that have lost association with their storage id, which is the case if the `secret_seed.txt` is changed or deleted. + The full client library of [file commands](https://github.com/vault12/zax/wiki/Zax-2.0-File-Commands) is implemented in the [Glow](https://github.com/vault12/glow.ts) library. ## Getting Started @@ -72,8 +73,8 @@ Zax requires [Redis](http://redis.io/) to run. - via Brew: `brew install redis` and run `redis-server` or - [Download](https://redis.io/download) Redis -- [Build](https://github.com/antirez/redis#building-redis) Redis -- [Run](https://github.com/antirez/redis#running-redis) Redis +- [Build](https://github.com/redis/redis#building-redis) Redis +- [Run](https://github.com/redis/redis#running-redis) Redis #### Sodium - brew install libsodium