Skip to content

Commit 9ffb8ab

Browse files
committed
update docs
1 parent 4f79fdb commit 9ffb8ab

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
## Project Documentation
1+
# Cpu Profiling - Tools, Docs, Research
22

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

6-
## Project Overviews
6+
## Project Overviews 🌟
77

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

1010
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.
1111

12-
### @push-based/nx-perf
12+
### **⚠️ DEPRECATED** [@push-based/nx-perf](./packages/nx-perf/README.md)
1313

1414
This tool focuses on visualizingexisting performance marks specifically for Nx CLI commands. It aims to provide more detailed insights than the default Nx performance logging. It generates flame graphs viewable in Chrome DevTools, showing time spent in functions and call stacks, including those from child processes.
1515

16-
**Note:** `@push-based/nx-perf` is an older or more rough version to profile Nx processes. `@push-based/cpu-prof` is the more current and general-purpose tool for CPU profiling and is recommended for Nx projects.
16+
> **⚠️ DEPRECATION NOTICE:** `@push-based/nx-perf` is an older or more rough version to profile Nx processes. `@push-based/cpu-prof` 🚀 is the more current and general-purpose tool for CPU profiling and is **highly recommended** for Nx projects.

0 commit comments

Comments
 (0)