Skip to content

Commit aefe828

Browse files
committed
refactor: update README with new branding and enhanced features
1 parent cddc145 commit aefe828

File tree

2 files changed

+105
-44
lines changed

2 files changed

+105
-44
lines changed

README.md

Lines changed: 105 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,135 @@
1-
# JSON Viewer Browser Extension
1+
# JSON Pilot ✈️
22

3-
A powerful browser extension for viewing, formatting, and exploring JSON content in your browser. Works with both Chrome and Firefox.
3+
![JSON Pilot](cover.png)
44

5-
## Features
5+
A powerful browser extension for viewing, formatting, and exploring JSON content in your browser. Transform raw JSON data into an interactive, beautifully formatted tree view with powerful exploration features.
66

7-
- 🎨 Automatic JSON detection and formatting
8-
- 🌳 Collapsible and expandable JSON tree view
9-
- 🔍 Search within JSON content
10-
- 📋 Copy JSON paths and values
11-
- 🎭 Light/Dark theme support
12-
- 🗺️ Optional minimap for navigation
13-
- 🔧 Customizable initial expansion depth
14-
- ⚡ Performance optimized for large JSON files
7+
## ✨ Features
158

16-
## Installation
9+
- 🎨 **Beautiful Interface**: Clean, modern design with intuitive controls
10+
- 🌗 **Theme Support**: Switch between light and dark themes
11+
- 🔍 **Interactive Exploration**:
12+
- Expand/collapse nodes
13+
- Click to select nodes
14+
- Copy JSON paths
15+
- Copy selected values
16+
- 🎯 **Path Navigation**: Visual path display for selected nodes
17+
- 🚀 **Performance Optimized**: Handles large JSON files with ease
18+
- 💡 **Smart Detection**: Automatically detects and formats JSON content
19+
- 🛡️ **Privacy Focused**: All processing happens locally in your browser
20+
- 🔒 **Secure**: No external servers, no data collection
1721

18-
### Chrome
19-
1. Clone this repository
22+
## 🚀 Quick Start
23+
24+
### Chrome Installation
25+
1. Download the latest release from [GitHub Releases](https://github.com/7angle/json-pilot/releases)
2026
2. Open Chrome and navigate to `chrome://extensions`
2127
3. Enable "Developer mode" in the top right
2228
4. Click "Load unpacked" and select the extension directory
2329

24-
### Firefox
25-
1. Clone this repository
30+
### Firefox Installation
31+
1. Download the latest release from [GitHub Releases](https://github.com/7angle/json-pilot/releases)
2632
2. Open Firefox and navigate to `about:debugging`
2733
3. Click "This Firefox" in the sidebar
2834
4. Click "Load Temporary Add-on" and select the `manifest.json` file
2935

30-
## Development
36+
## 💻 Development
3137

3238
### Prerequisites
39+
- Node.js 16.x or higher
40+
- npm 7.x or higher
3341
- Modern web browser (Chrome 88+ or Firefox 109+)
34-
- Basic understanding of web technologies
42+
43+
### Setup
44+
```bash
45+
# Clone the repository
46+
git clone https://github.com/7angle/json-pilot.git
47+
48+
# Navigate to project directory
49+
cd json-pilot
50+
51+
# Install dependencies
52+
npm install
53+
54+
# Start development server
55+
npm run dev
56+
57+
# Build for production
58+
npm run build
59+
```
3560

3661
### Project Structure
3762
```
38-
json-viewer/
63+
json-pilot/
64+
├── src/ # Source code
65+
│ ├── App.vue # Main application component
66+
│ ├── components/ # Vue components
67+
│ └── main.js # Application entry point
68+
├── public/ # Static assets
3969
├── manifest.json # Extension manifest
40-
├── background.js # Background script
41-
├── content.js # Content script
42-
├── viewer.html # JSON viewer interface
43-
├── viewer.css # Styles for the viewer
44-
├── viewer.js # Viewer functionality
45-
└── icons/ # Extension icons
70+
├── background.js # Background script
71+
├── content.js # Content script
72+
└── vite.config.js # Vite configuration
4673
```
4774

48-
### Building
49-
No build step required! The extension can be loaded directly into browsers in development mode.
75+
## 🎯 Usage
76+
77+
1. **View JSON**: Navigate to any URL that returns JSON content
78+
- The extension automatically detects and formats JSON
79+
- Raw JSON text is also transformed into the viewer
80+
81+
2. **Interact with JSON**:
82+
- Click the expand/collapse icons to explore nested objects
83+
- Click on any value to select it
84+
- Use the copy button to copy selected JSON
85+
- Toggle between light and dark themes
5086

51-
## Usage
87+
3. **Navigation**:
88+
- Use the path display to understand your location in the JSON structure
89+
- Click the expand/collapse all button to quickly view or hide all nodes
5290

53-
1. Navigate to any URL that returns JSON content
54-
2. The extension will automatically detect and format the JSON
55-
3. Use the toolbar to:
56-
- Expand/collapse nodes
57-
- Search within the JSON
58-
- Copy JSON paths
59-
- Toggle dark/light theme
60-
- Show/hide minimap
61-
4. Click on any value to copy it
62-
5. Hover over objects to see their full path
91+
## 🤝 Contributing
6392

64-
## Contributing
93+
We welcome contributions! Here's how you can help:
6594

6695
1. Fork the repository
67-
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
68-
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
69-
4. Push to the branch (`git push origin feature/amazing-feature`)
96+
2. Create your feature branch:
97+
```bash
98+
git checkout -b feature/amazing-feature
99+
```
100+
3. Commit your changes:
101+
```bash
102+
git commit -m 'feat: add amazing feature'
103+
```
104+
4. Push to the branch:
105+
```bash
106+
git push origin feature/amazing-feature
107+
```
70108
5. Open a Pull Request
71109

72-
## License
110+
Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and development process.
111+
112+
## 📜 License
113+
114+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
115+
116+
## 🔒 Privacy
117+
118+
JSON Pilot takes your privacy seriously. All JSON processing happens locally in your browser - no data is ever sent to external servers. Read our [Privacy Policy](PRIVACY.md) for more details.
119+
120+
## 📞 Support
121+
122+
- 📧 Email: hello@7angle.com
123+
- 🐛 Issues: [GitHub Issues](https://github.com/7angle/json-pilot/issues)
124+
- 📦 Releases: [GitHub Releases](https://github.com/7angle/json-pilot/releases)
125+
126+
## ⭐ Show Your Support
127+
128+
If you find JSON Pilot helpful, please consider:
129+
- Starring the repository
130+
- Sharing it with others
131+
- [Reporting issues](https://github.com/7angle/json-pilot/issues) if you find any
132+
- Contributing to the project
73133

74-
This project is licensed under the MIT License - see the LICENSE file for details.
134+
---
135+
Made with ❤️ by [7 Angle](https://7angle.com)

cover.png

92.3 KB
Loading

0 commit comments

Comments
 (0)