Skip to content

Commit 8407498

Browse files
committed
feat: add README.md
1 parent 88de442 commit 8407498

File tree

7 files changed

+210
-0
lines changed

7 files changed

+210
-0
lines changed

DEVELOPMENT.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# For Developers
2+
3+
## 🛠️ Building from Source
4+
5+
### Prerequisites
6+
7+
- Node.js (v16 or higher)
8+
- Rust (latest stable)
9+
- npm or yarn
10+
11+
### Setup
12+
13+
```bash
14+
# Clone the repository
15+
git clone https://github.com/rebase/json-prettier.git
16+
cd json-prettier
17+
18+
# Install dependencies
19+
npm install
20+
21+
# Run in development mode
22+
npm run tauri dev
23+
24+
# Build for production
25+
npm run tauri build
26+
```
27+
28+
## 📦 Open Source Libraries Used
29+
30+
**Frontend:**
31+
32+
- [React](https://react.dev/) - UI framework
33+
- [TypeScript](https://www.typescriptlang.org/) - Type safety
34+
- [Vite](https://vitejs.dev/) - Build tool
35+
- [Monaco Editor](https://microsoft.github.io/monaco-editor/) - Code editor component
36+
- [Lucide React](https://lucide.dev/) - Icon library
37+
38+
**Backend (Rust):**
39+
40+
- [Tauri](https://tauri.app/) - Desktop app framework
41+
- [Serde](https://serde.rs/) - Serialization/deserialization
42+
- [Serde JSON](https://docs.rs/serde_json/) - JSON handling

INSTALLATION.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Installation Guide
2+
3+
## macOS Installation
4+
5+
### Security Warning Fix
6+
7+
When you first download and run JSON Prettier on macOS, you may see a security warning:
8+
9+
> "Apple could not verify JSON Prettier.app is free of malware..."
10+
11+
This is normal for apps that aren't signed with an Apple Developer Certificate. To run the app:
12+
13+
**Method 1: System Settings**
14+
15+
1. Go to **System Settings → Privacy & Security**
16+
2. Find "JSON Prettier.app was blocked" message
17+
3. Click **"Open Anyway"**
18+
19+
**Method 2: Right-click**
20+
21+
1. Right-click on the app
22+
2. Select **"Open"**
23+
3. Click **"Open"** in the dialog
24+
25+
This only needs to be done once. After that, the app will run normally.
26+
27+
## Windows Installation
28+
29+
Download the `.msi` installer and run it. Windows Defender may show a warning - click "More info" → "Run anyway".
30+
31+
## Linux Installation
32+
33+
Download the `.AppImage` file:
34+
35+
1. Make it executable: `chmod +x JSON-Prettier_*.AppImage`
36+
2. Run: `./JSON-Prettier_*.AppImage`
37+
38+
Or install via package manager if available.
39+
40+
---
41+
42+
**Why this happens**: We're an open-source project and don't have an Apple Developer Certificate ($99/year). The app is completely safe - you can verify the source code on GitHub.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 JSON Prettier
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# JSON Prettier
2+
3+
<div align="center">
4+
<img src="src-tauri/icons/icon.png" alt="JSON Prettier Logo" width="128" height="128">
5+
6+
[![Version](https://img.shields.io/badge/version-0.1.0-blue.svg)](https://github.com/rebase/json-prettier)
7+
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
8+
</div>
9+
10+
---
11+
12+
<div align="center">
13+
<table>
14+
<tr>
15+
<td width="33%" align="center">
16+
<img src="docs/images/main-interface.png" alt="Main Interface" width="100%" style="margin-bottom: 5px;">
17+
<br>
18+
<strong>Main Interface</strong>
19+
</td>
20+
<td width="33%" align="center">
21+
<img src="docs/images/dark-theme.png" alt="Dark Theme" width="100%" style="margin-bottom: 5px;">
22+
<br>
23+
<strong>Dark Theme</strong>
24+
</td>
25+
<td width="33%" align="center">
26+
<img src="docs/images/settings-panel.png" alt="Settings Panel" width="100%" style="margin-bottom: 5px;">
27+
<br>
28+
<strong>Settings Panel</strong>
29+
</td>
30+
</tr>
31+
</table>
32+
</div>
33+
34+
## 📥 Download
35+
36+
<div align="center">
37+
<table>
38+
<tr>
39+
<td align="center" width="33%">
40+
<img src="https://upload.wikimedia.org/wikipedia/commons/f/fa/Apple_logo_black.svg" alt="macOS" width="40" height="40">
41+
<br>
42+
<strong>macOS</strong>
43+
<br>
44+
<a href="https://github.com/rebase/json-prettier/releases/latest/download/JSON.Prettier_0.1.0_aarch64.dmg">Apple Silicon (M1/M2)</a>
45+
<br>
46+
<a href="https://github.com/rebase/json-prettier/releases/latest/download/JSON.Prettier_0.1.0_x64.dmg">Intel</a>
47+
</td>
48+
<td align="center" width="33%">
49+
<img src="https://upload.wikimedia.org/wikipedia/commons/5/5f/Windows_logo_-_2012.svg" alt="Windows" width="40" height="40">
50+
<br>
51+
<strong>Windows</strong>
52+
<br>
53+
<a href="https://github.com/rebase/json-prettier/releases/latest/download/JSON.Prettier_0.1.0_x64-setup.exe">Setup (.exe)</a>
54+
<br>
55+
<a href="https://github.com/rebase/json-prettier/releases/latest/download/JSON.Prettier_0.1.0_x64.msi">MSI Installer</a>
56+
</td>
57+
<td align="center" width="33%">
58+
<img src="https://upload.wikimedia.org/wikipedia/commons/3/35/Tux.svg" alt="Linux" width="40" height="40">
59+
<br>
60+
<strong>Linux</strong>
61+
<br>
62+
<a href="https://github.com/rebase/json-prettier/releases/latest/download/json-prettier_0.1.0_amd64.AppImage">AppImage</a>
63+
<br>
64+
<a href="https://github.com/rebase/json-prettier/releases/latest/download/json-prettier_0.1.0_amd64.deb">Debian (.deb)</a>
65+
</td>
66+
</tr>
67+
</table>
68+
</div>
69+
70+
> **macOS Users**: You may see an "untrusted developer" warning on first launch.
71+
> Right-click the app and select "Open" to bypass this. See our [Installation Guide](INSTALLATION.md) for details.
72+
73+
---
74+
75+
## 📝 What is JSON Prettier?
76+
77+
JSON Prettier is a simple desktop app that makes messy JSON data look clean and organized. Whether you're a developer, data analyst, or just someone who works with JSON files, this app will help you format and read JSON data easily.
78+
79+
## ✨ Features
80+
81+
- 📂 **Open JSON files** - Load JSON from your computer
82+
- 💾 **Save formatted JSON** - Export cleaned up data
83+
- 🔄 **Auto-save settings** - Remembers your preferences
84+
- 🌙 **Dark/Light themes** - Choose your preferred look
85+
- 📋 **Copy/Paste support** - Quick text operations
86+
- 🎨 **Syntax highlighting** - Easy to read colored JSON
87+
-**Fast formatting** - Instant JSON beautification
88+
89+
## 🐛 Something Not Working?
90+
91+
Found a problem? Let us know! Go to our [Issues page](https://github.com/rebase/json-prettier/issues) and tell us:
92+
93+
- What computer you're using (Mac, Windows, Linux)
94+
- What version of the app you have
95+
- What you were trying to do
96+
- What happened vs what you expected
97+
- A screenshot if possible
98+
99+
## 🛠️ For Developers
100+
101+
Want to contribute or build from source? Check out our [Development Guide](DEVELOPMENT.md)
102+
103+
<div align="center">
104+
⭐ If you find this project useful, please give it a star!
105+
</div>

docs/images/dark-theme.png

568 KB
Loading

docs/images/main-interface.png

551 KB
Loading

docs/images/settings-panel.png

474 KB
Loading

0 commit comments

Comments
 (0)