Skip to content

Commit b19efa3

Browse files
authored
docs: update docs for new features include (#16)
1 parent 444b22a commit b19efa3

File tree

1 file changed

+43
-13
lines changed

1 file changed

+43
-13
lines changed

README.md

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,56 @@
11
# JSONP - Multitab JSON Previewer
22

3-
A simple, open-source web-based tool to preview and explore JSON data. This tool allows you to view JSON in both Raw and Tree formats, with features like search, syntax highlighting, and collapsible nodes.
3+
JSONP is a simple, open-source web-based tool for previewing and exploring JSON data. It provides a rich interface to work with JSON in multiple modes—formatting, comparing, and even generating code. With features like multiple tabs, dynamic updates, and dark mode support, JSONP makes it easy to work with JSON data in your browser.
44

55
## Features
66

7-
- Multiple Tabs: Work with multiple JSON files simultaneously.
8-
- Tab Name Editing: You can name the tabs for easier identification
9-
- Raw JSON View: View JSON in a formatted, syntax-highlighted raw format.
10-
- Tree View: Explore JSON in a collapsible tree structure.
11-
- Search Functionality: Search for keys or values in both Raw and Tree views.
12-
- Error Handling: Displays errors if the JSON is invalid.
13-
- Dynamic Updates: Real-time updates as you type or edit JSON.
7+
- **Multiple Modes & Tabs:**
8+
Work with JSON data across three modes:
9+
- **JSON Formatter:** View and edit JSON data in both Raw and Tree formats.
10+
- **JSON Compare:** Compare two JSON documents side-by-side with line-by-line diff highlighting.
11+
- **JSON to Code Generator:** Convert JSON into code for various languages (TypeScript, Python, Go).
12+
13+
- **Tab Name Editing:**
14+
Rename tabs easily for better organization.
15+
16+
- **Raw JSON View:**
17+
Automatically format and syntax–highlight JSON in a raw view.
18+
19+
- **Tree View:**
20+
Explore JSON in a collapsible tree structure that lets you drill down into nested data.
21+
22+
- **Search Functionality:**
23+
Find and highlight specific keys or values in both Raw and Tree views.
24+
25+
- **Error Handling:**
26+
Displays clear error messages when the JSON is invalid.
27+
28+
- **Dynamic Updates:**
29+
The tool automatically formats JSON on paste and blur events, and updates diff previews and code output in real time.
30+
31+
- **Dark Mode Support:**
32+
Enjoy a fully themed dark mode with adaptive UI elements, including diff highlighting that adjusts based on the current theme.
1433

1534
## How to Use
1635

17-
1. Enter JSON: Paste or type your JSON into the textarea.
18-
2. Switch Views: Use the tabs to switch between Raw JSON and Tree View.
19-
3. Search: Use the search box to find and highlight specific keys or values.
20-
4. Collapse/Expand: In the Tree View, click on nodes to collapse or expand them.
21-
5. Multiple Tabs: Add new tabs to work with multiple JSON files at once.
36+
1. **Select a Mode:**
37+
Choose from the three mode buttons at the top:
38+
- **JSON Formatter:** For viewing and editing JSON in Raw and Tree formats.
39+
- **JSON Compare:** For comparing two JSON documents side-by-side.
40+
- **JSON to Code Generator:** For converting JSON into code.
41+
42+
2. **Add a Tab:**
43+
Click the **"+ Add Tab"** button in your selected mode to open a new tab. Each mode manages its own set of tabs.
2244

45+
3. **Enter Your JSON:**
46+
- **Formatter Mode:** Paste or type your JSON into the textarea. The JSON is automatically formatted and can be viewed in either Raw or Tree view.
47+
- **Compare Mode:** Enter JSON into both the left and right textareas. Click the **"Compare JSONs"** button to see a side-by-side diff. Differences are highlighted (with colors that adapt for dark mode).
48+
- **Code Generator Mode:** Paste your JSON into the textarea, select a target language (TypeScript, Python, or Go) from the dropdown, and click **"Generate Code"** to see the output.
2349

50+
4. **Switch Views & Search:**
51+
- In **Formatter Mode**, switch between Raw and Tree views using the tabs inside each JSON tab.
52+
- Use the search box to find and highlight specific keys or values.
53+
- In **Tree View**, click nodes to collapse or expand sections of your JSON.
2454
## Contributing
2555

2656
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

0 commit comments

Comments
 (0)