react-scanner-ui 0.0.11 → 0.0.13

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 (7) hide show
  1. package/README.md +43 -2
  2. package/docs/.vitepress/config.ts +1 -0
  3. package/docs/index.md +3 -0
  4. package/docs/public/favicon.ico +0 -0
  5. package/docs/public/logo.png +0 -0
  6. package/logo.png +0 -0
  7. package/package.json +3 -1
package/README.md CHANGED
@@ -1,2 +1,43 @@
1
- # react-scanner-ui
2
- A dashboard generator that transforms 'react-scanner' output into a portable, interactive component usage inventory and insights
1
+ <div align="center">
2
+ <img src="./logo.png" alt="React Scanner UI Logo" width="100" height="100">
3
+
4
+ # React Scanner UI
5
+
6
+ ## Component scanner and visualization tool for React applications
7
+ </div>
8
+
9
+ [![npm version](https://badge.fury.io/js/react-scanner-ui.svg)](https://badge.fury.io/js/react-scanner-ui)
10
+ [![GitHub stars](https://img.shields.io/github/stars/vimalmunjani/react-scanner-ui?style=social)](https://github.com/vimalmunjani/react-scanner-ui/stargazers)
11
+
12
+ ## 🚀 First Release - February 1st, 2025
13
+
14
+ The initial version of React Scanner UI is launching February 1st!
15
+
16
+ **Support the project:**
17
+ - ⭐ [Star on GitHub](https://github.com/vimalmunjani/react-scanner-ui)
18
+ - 💬 [Join Discussions](https://github.com/vimalmunjani/react-scanner-ui/discussions)
19
+
20
+ ## Installation
21
+
22
+ ```bash
23
+ yarn add react-scanner-ui
24
+ # or
25
+ npm install react-scanner-ui
26
+ # or
27
+ npx react-scanner-ui
28
+ ```
29
+
30
+ ## Usage
31
+
32
+ ```bash
33
+ cd your-react-project
34
+ react-scanner-ui init
35
+ ```
36
+
37
+ ## Documentation
38
+
39
+ 📖 [Full Documentation](https://vimalmunjani.github.io/react-scanner-ui/)
40
+
41
+ ---
42
+
43
+ MIT © [Vimal Munjani](https://github.com/vimalmunjani)
package/docs/.vitepress/config.ts CHANGED
@@ -6,6 +6,7 @@ export default defineConfig({
6
6
  base: '/react-scanner-ui/',
7
7
 
8
8
  themeConfig: {
9
+ logo: '/logo.png',
9
10
  nav: [
10
11
  { text: 'Home', link: '/' },
11
12
  { text: 'Guide', link: '/guide/' },
package/docs/index.md CHANGED
@@ -5,6 +5,9 @@ hero:
5
5
  name: 'React Scanner UI'
6
6
  text: 'Component Scanner & Visualization Tool'
7
7
  tagline: 'Scan, analyze, and visualize your React components with ease'
8
+ image:
9
+ src: /logo.png
10
+ alt: React Scanner UI Logo
8
11
  actions:
9
12
  - theme: brand
10
13
  text: Get Started
package/docs/public/favicon.ico ADDED
Binary file
package/docs/public/logo.png ADDED
Binary file
package/logo.png ADDED
Binary file
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "react-scanner-ui",
3
3
  "type": "module",
4
- "version": "0.0.11",
4
+ "version": "0.0.13",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
7
7
  "react-scanner-ui": "dist/index.js"
@@ -10,6 +10,8 @@
10
10
  "type": "git",
11
11
  "url": "git+https://github.com/vimalmunjani/react-scanner-ui.git"
12
12
  },
13
+ "homepage": "https://vimalmunjani.github.io/react-scanner-ui/",
14
+ "logo": "logo.png",
13
15
  "author": "Vimal Munjani <vimal.j.munjani@gmail.com>",
14
16
  "license": "MIT",
15
17
  "publishConfig": {