aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2019-01-04 13:26:18 -0800
committerBryan Newbold <bnewbold@robocracy.org>2019-01-04 13:26:18 -0800
commit3aee89745355b0ced5223c601a03f77e46d997dc (patch)
tree80243a881f707d6cc0e9b9543edfe44486f1260c
parent67d56af9447a69700a5a2ad816efcace679145d2 (diff)
downloadfatcat-3aee89745355b0ced5223c601a03f77e46d997dc.tar.gz
fatcat-3aee89745355b0ced5223c601a03f77e46d997dc.zip
update rust README
-rw-r--r--rust/README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/rust/README.md b/rust/README.md
index a6bb34b6..decfc74d 100644
--- a/rust/README.md
+++ b/rust/README.md
@@ -1,5 +1,17 @@
-Rust implementation of fatcat API server (`fatcatd`).
+Rust implementation of fatcat API server. Commands include:
+
+- `fatcatd`: the API server itself
+- `fatcat-auth`: privileged command to manage authentication keys, tokens, and
+ accounts. Useful to generate admin accounts, new signing keys, etc.
+- `fatcat-export`: high-speed JSON export tool, which talks directly to the
+ database (instead of going through the API). See `README.export.md`.
+
+The `fatcat-api-spec` crate is generated from the openapi/swagger spec and
+contains Rust models, response types, and endpoint definitions (but not
+implementations).
+
+The SQL database schema (and migrations) are under `./migrations/`.
## Development
@@ -32,6 +44,9 @@ Tests:
cargo test -- --test-threads 1
+Note that most "integration" level tests are written in python and run by
+`pytest`; see `../python/README.md`.
+
See `HACKING` for some more advanced tips and commands.
## Configuration