Skip to content

chore: update README.md and CHANGELOG.md #18

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.

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
merged 1 commit into from
Feb 27, 2025
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
- Thanks @rksm!
- notes: the addition of `origin_base_url` implies that `WasmLayerConfig` is no longer copy.

### Changed
- `set_as_global_default_with_config` now returns a Result. This will fail if the global default is already set.

### Removed
- `WASMLayerConfig` and `WASMLayer` type aliases. Use `WasmLayerConfig` and `WasmLayer`, respectively.

Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ Leverage performance profiling with your browser tools with the [tracing crate](

Note: `wasm_tracing` uses the global JavaScript `console` and `performance` objects. It will not work in environments where one or both of these are not available, such as Node.js or Cloudflare Workers.


## TODOs
These features are things I'd like to do with `wasm-tracing`. Suggestions, comments, and complaints are encouraged!
Please file an issue if you are passionate about a particular use-case or implementation detail.
- [ ] Traces from `#[tracing::instrument]` macro should be visible in the console
- [ ] Rewrite how the config works, possibly dependent/mirrored by another `tracing` crates' config w/ console specifics

## Usage

For the simplest out of the box set-up, you can simply set `wasm_tracing` as your default tracing Subscriber in wasm_bindgen(start)
Expand Down
Loading