Skip to content

docs: remove outdated README sections #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henrylee97 merged 1 commit into from
Jun 2, 2026
Merged

docs: remove outdated README sections #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 0 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,19 +62,3 @@ let job_logger =
logger
|> Scribe.with_field (Scribe.Field.string "job_id" job_id)
```

## Library-Friendly Use

Libraries should accept an optional logger and default to `Scribe.noop`.

```ocaml
let parse ?(logger = Scribe.noop) path =
Scribe.debug logger "parse started"
[ Scribe.Field.string "file" path ];
(* parsing work *)
()
```

## MVP Scope

The first version focuses on value-based structured logging and a small sink collection with noop and JSON lines sinks. Other logging adapters are intentionally left out of the MVP.