commit 7de5297369268a4e49a1beff49a0c1d064d4cee3
parent f47555cf98ff0b13e11f45a0e74e21b8d35a3cdc
Author: lash <dev@holbrook.no>
Date: Sat, 13 Jul 2024 22:15:01 +0100
Rewrite readme
Diffstat:
7 files changed, 134 insertions(+), 56 deletions(-)
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,10 @@
+- 0.1.7
+ * Update engine constraint
+ * Add makefile
+ * Bump version
+ * Rewrite readme upstream source to asciidoc
+- 0.1.6
+ * Add readme, license, copyright
- 0.1.5
* Return 200 on empty get
* Set "X-Wala-Cap" header to "default" when no extra capabilities are present
diff --git a/Cargo.lock b/Cargo.lock
@@ -1453,7 +1453,7 @@ checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"
[[package]]
name = "wala"
-version = "0.1.6"
+version = "0.1.7"
dependencies = [
"ascii",
"base64 0.13.1",
diff --git a/Makefile b/Makefile
@@ -0,0 +1,22 @@
+all:
+ cargo -v --bin wala --all-features --release
+
+rustup:
+ rustup run 1.67 cargo build -v --bin wala --all-features --release
+
+debug:
+ rustup run 1.67 cargo build -v --all-features
+
+test:
+ rustup run 1.67 cargo test -v --all-features
+
+doc:
+ -asciidoc -b docbook5 README.adoc
+ -pandoc -f docbook -t gfm -o README.md README.xml
+ -pandoc -f docbook -t plain -o README.txt README.xml
+ rm -vf README.xml
+
+clean:
+ rm -vrf target/
+
+.PHONY: clean
diff --git a/README b/README
@@ -1,36 +0,0 @@
-Make sure you use the following toolchain (rustup):
-
-nightly-2022-11-14-x86_64-unknown-linux-gnu
-
-Build the binaries:
-
-$ cargo build --all-features --release
-
-Build the Docker image:
-
-$ docker build -t wala:latest .
-
-or
-
-$ docker buildx build -t wala:latest .
-
-Running the server
-
-$ ./target/release/wala -d <storage_directory>
-
-Logging output detail can be adjusted by setting environment variable RUST_LOG to debug, info, warn or error.
-
-
-Upload the string "foo" using the send tool
-
-$ ./target/release/wala_send -u http://localhost:8000 foo
-
-
-Upload the string "xyzzy" under a mutable reference with keyword "foo" using the send tool:
-
-$ ./target/release/wala_send -u http://localhost:8000 -k <pgp key fingerprint> -i bar xyzzy
-
-
-Note!
-
-Wala is not intended to be used by itself in a production environment. Please consider setting a reverse proxy in front of it.
diff --git a/README.adoc b/README.adoc
@@ -0,0 +1,41 @@
+Wala
+====
+
+HTTP service that makes uploaded content available at the path of its digests(s)
+
+Currently only `SHA256` is supported.
+
+CAUTION: Wala is not intended to be used by itself in a production environment. Please consider setting a reverse proxy in front of it.
+
+
+Build
+-----
+
+Rustup example:
+
+`rustup run 1.67 cargo build -v --bin --all-features --release`
+
+
+Running
+-------
+
+`./target/release/wala -d <storage_directory>`
+
+Logging output detail can be adjusted by setting environment variable RUST_LOG to debug, info, warn or error.
+
+`./target/release/wala --help` for more options.
+
+.Example interaction
+
+[source,bash]
+curl -X PUT http://localhost:8000 --data "foo"
+2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae
+curl -X GET http://localhost:8000/2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae
+foo
+
+
+
+Known issues
+------------
+
+`wala_send` is broken `:'(`
diff --git a/README.md b/README.md
@@ -0,0 +1,43 @@
+HTTP service that makes uploaded content available at the path of its
+digests(s)
+
+Currently only `SHA256` is supported.
+
+<div class="caution">
+
+Wala is not intended to be used by itself in a production environment.
+Please consider setting a reverse proxy in front of it.
+
+</div>
+
+# Build
+
+Rustup example:
+
+`rustup run 1.67 cargo build -v --bin --all-features --release`
+
+# Running
+
+`./target/release/wala -d <storage_directory>`
+
+Logging output detail can be adjusted by setting environment variable
+RUST_LOG to debug, info, warn or error.
+
+`./target/release/wala --help` for more options.
+
+<div class="formalpara-title">
+
+**Example interaction**
+
+</div>
+
+``` bash
+curl -X PUT http://localhost:8000 --data "foo"
+2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae
+curl -X GET http://localhost:8000/2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae
+foo
+```
+
+# Known issues
+
+`wala_send` is broken `:'(`
diff --git a/README.txt b/README.txt
@@ -1,32 +1,33 @@
-Build the binaries:
+HTTP service that makes uploaded content available at the path of its
+digests(s)
-$ cargo build --all-features --release
+Currently only SHA256 is supported.
-Build the Docker image:
+Wala is not intended to be used by itself in a production environment.
+Please consider setting a reverse proxy in front of it.
-$ docker build -t wala:latest .
+Build
-or
+Rustup example:
-$ docker buildx build -t wala:latest .
+rustup run 1.67 cargo build -v --bin --all-features --release
-Running the server
+Running
-$ ./target/release/wala -d <storage_directory>
+./target/release/wala -d <storage_directory>
-Logging output detail can be adjusted by setting environment variable RUST_LOG to debug, info, warn or error.
+Logging output detail can be adjusted by setting environment variable
+RUST_LOG to debug, info, warn or error.
+./target/release/wala --help for more options.
-Upload the string "foo" using the send tool
+Example interaction
-$ ./target/release/wala_send -u http://localhost:8000 foo
+ curl -X PUT http://localhost:8000 --data "foo"
+ 2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae
+ curl -X GET http://localhost:8000/2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae
+ foo
+Known issues
-Upload the string "xyzzy" under a mutable reference with keyword "foo" using the send tool:
-
-$ ./target/release/wala_send -u http://localhost:8000 -k <pgp key fingerprint> -i bar xyzzy
-
-
-Note!
-
-Wala is not intended to be used by itself in a production environment. Please consider setting a reverse proxy in front of it.
+wala_send is broken :'(
