Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,20 @@ Cargo workspace (`resolver = "2"`), four crates under `crates/`:

| Crate | Role |
|-------|------|
| `ltk_hashdb` | The `.hashdb` format: `mmap` reader (`HashDb`) + streaming writer (`HashDbWriter`), `ExtendedHashDb` overlay |
| `ltk_hashdb` | The `.hashdb` format: `mmap` reader (`HashDb`) + streaming writer (`HashDbWriter`), `LayeredHashDb` overlay |
| `ltk_mimir_cache` | Shared cache dir, `manifest.json`, versioned publish, update lock, GC, in-process updater (`HashStore`, `HashStore::update`) |
| `ltk_mimir_gen` | Hash-discovery ("hunt") engine - guessers that resolve unknown hashes |
| `ltk_mimir_cli` | The `mimir` binary (`build` / `get` / `verify` / `stats` / `gen` / `update` / `merge` / `bundle`) |

Docs live in `docs/`: `FORMAT.md` (byte-level spec, format version 1), `CONSUMERS.md`
(integration API), `BENCHMARKS.md` (frame-size/compression measurements).
Docs live in `docs/`: `DESIGN.md` (rationale, how the format works, measurements -
the narrative the README used to carry), `FORMAT.md` (byte-level spec, format version 1),
`CONSUMERS.md` (integration API), `BENCHMARKS.md` (frame-size/compression measurements),
`ROADMAP.md` (planned work, in dependency order, with the additive-only constraints that
govern it).

`README.md` is the usage front door: install, quick start, the API surface with examples,
and the CLI. Keep its examples true to the current API - they are typechecked by hand, not
by CI.

## Conventions

Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ members = ["crates/*"]

[workspace.package]
edition = "2021"
license = "MIT OR Apache-2.0"
license = "Apache-2.0"
repository = "https://github.com/LeagueToolkit/mimir"
authors = ["League Toolkit contributors"]
authors = ["Crauzer <0xcrauzer@proton.me>", "League Toolkit contributors"]

[workspace.dependencies]
# Internal crates (path-linked within this workspace; the published ones also
Expand Down
File renamed without changes.
21 changes: 0 additions & 21 deletions LICENSE-MIT

This file was deleted.

16 changes: 16 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
mimir
Copyright 2026 Crauzer <0xcrauzer@proton.me>

This product includes software developed by Crauzer and the League Toolkit
contributors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
Loading
Loading