Add project overview and align build metadata

This commit is contained in:
ms2k 2026-08-20 00:21:28 +09:00
commit 754acda2db
3 changed files with 24 additions and 1 deletions

View file

@ -2,7 +2,7 @@
ARG RUST_IMAGE=docker.io/library/rust:1.97.0-bookworm@sha256:8fa55b2f3ddf97471ab6a767bfa3f37e6bad0986ba823e75fea57e2a2a5c3073
ARG NODE_IMAGE=docker.io/library/node:24.18.0-bookworm@sha256:5711a0d445a1af54af9589066c646df387d1831a608226f4cd694fc59e745059
ARG PLAYWRIGHT_IMAGE=mcr.microsoft.com/playwright:v1.61.1-noble@sha256:5b8f294aff9041b7191c34a4bab3ac270157a28774d4b0660e9743297b697e48
ARG PLAYWRIGHT_IMAGE=mcr.microsoft.com/playwright:v1.62.1-noble@sha256:dcc5531e97840b9b5e794f2814476b21571c5124a3fca2267d73041f56e7580e
FROM ${RUST_IMAGE} AS rust-tools
ADD --checksum=sha256:0c593171ba53aaaf699f8fd5d8d6661abcb004cfe2ffd01e206c7992909a4d05 https://static.crates.io/crates/cargo-nextest/cargo-nextest-0.9.140.crate /tmp/cargo-nextest-0.9.140.crate

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# Remora
Remora is a multi-user service that runs durable download jobs from HTTP, S3-compatible object stores, and Hugging Face repositories into S3-compatible object storage. It provides a browser interface and API backed by stateless API and worker services.
Remora is early in development. Interfaces, deployment behavior, and compatibility may change, so evaluate it carefully before relying on it. The [architecture specification](docs/spec/architecture.md) describes the current design.
## Build
Use the Rust and Node.js versions pinned by `rust-toolchain.toml` and `.node-version`. Enable Corepack so the package manager version declared by the web workspace is used.
```sh
cargo build --workspace --locked
corepack enable
pnpm --dir web install --frozen-lockfile
pnpm --dir web build
```
Deployment and verification details are in the [deployment](docs/spec/deployment.md) and [testing](docs/spec/testing.md) documentation.
## License
Remora is licensed under the [Apache License 2.0](LICENSE). See [NOTICE](NOTICE) for the project notice.

View file

@ -2,6 +2,7 @@
name = "remora-schema"
edition.workspace = true
license.workspace = true
publish = false
rust-version.workspace = true
version.workspace = true