@rn-perf-kit/overlay 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +19 -0
  2. package/package.json +21 -3
package/README.md ADDED
@@ -0,0 +1,19 @@
1
+ # @rn-perf-kit/overlay
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@rn-perf-kit/overlay.svg?style=flat-square&color=CB3837)](https://www.npmjs.com/package/@rn-perf-kit/overlay)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
5
+
6
+ > In-app floating performance HUD overlay for **rn-perf-kit** apps.
7
+
8
+ Part of the [rn-perf-kit](https://github.com/arpitkumarsahu/rn-perf-kit) monorepo.
9
+
10
+ ## Usage
11
+
12
+ ```tsx
13
+ import { PerfOverlay } from '@rn-perf-kit/overlay';
14
+
15
+ <PerfOverlay position="top-right" />
16
+ ```
17
+
18
+ - Throttled to **2 Hz** to keep overhead < 0.5% CPU.
19
+ - Displays live UI FPS, JS FPS, long commits, stalls, and active screen.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rn-perf-kit/overlay",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "In-app performance HUD overlay for rn-perf-kit",
5
5
  "main": "./src/index.ts",
6
6
  "types": "./src/index.ts",
@@ -18,6 +18,24 @@
18
18
  "@types/react-native": "^0.73.0"
19
19
  },
20
20
  "dependencies": {
21
- "@rn-perf-kit/core": "^0.1.0"
22
- }
21
+ "@rn-perf-kit/core": "^0.1.1"
22
+ },
23
+ "author": "Arpit Kumar Sahu <aarpitkumarsahu99@gmail.com>",
24
+ "license": "MIT",
25
+ "repository": {
26
+ "type": "git",
27
+ "url": "git+https://github.com/arpitkumarsahu/rn-perf-kit.git",
28
+ "directory": "packages/overlay"
29
+ },
30
+ "bugs": {
31
+ "url": "https://github.com/arpitkumarsahu/rn-perf-kit/issues"
32
+ },
33
+ "homepage": "https://github.com/arpitkumarsahu/rn-perf-kit#readme",
34
+ "keywords": [
35
+ "react-native",
36
+ "hud",
37
+ "perf-overlay",
38
+ "fps-meter",
39
+ "in-app-hud"
40
+ ]
23
41
  }