Skip to content

feat: update docs #4

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 3 commits into from
Jun 22, 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
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Cpu Profiling - Tools, Docs, Research

- [cpu-prof](./packages/cpu-prof/README.md) 🚀
- [@push-based/nx-perf](./packages/nx-perf/README.md)
- [@push-based/nx-perf](./packages/
- nx-perf/README.md)

## Project Overviews 🌟

### [@push-based/cpu-prof](./packages/cpu-prof/README.md) 🚀

![cli-merge-focus-main-inc-command-overview.png](packages/cpu-prof/docs/imgs/cli-merge-focus-main-inc-command-overview.png)

This package provides tools for Node.js CPU profiling. It allows users to collect and merge CPU profiles, and visualize them as Chrome trace files. Key features include smart defaults for easier profiling, intuitive error messages, the ability to merge multiple CPU profile files, and a TypeScript API for programmatic access. It offers CLI commands like `measure` to collect profiles and `merge` to combine them. It aims to simplify the usage of Node.js's built-in `--cpu-prof` capabilities and centralizes profile output.

### **⚠️ DEPRECATED** [@push-based/nx-perf](./packages/nx-perf/README.md)
Expand Down
Loading
Loading