Skip to content

Commit 0f802d4

Browse files
committed
Update README.md
1 parent 40cb358 commit 0f802d4

1 file changed

Lines changed: 39 additions & 22 deletions

File tree

README.md

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,53 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
# JSONT (JSON Translate)
2+
3+
**JSONT** is a simple web application designed to facilitate translation of JSON files. It allows users to edit and translate JSON files using the Monaco Editor, with support for drag-and-drop functionality and saving shortcuts.
4+
5+
You can access it via <https://jsont.syntaxbox.dev>
6+
7+
## Features
8+
9+
- **Monaco Editor** for editing JSON files
10+
- Translation powered by **google-translate-api-x**
11+
- **Drag-and-Drop** support for easy file import
12+
- **Keyboard shortcut**: `Ctrl + S` to save the translated JSON file
13+
- Language specification required before translating
14+
- Translation is triggered by clicking the **Translate** button
215

316
## Getting Started
417

5-
First, run the development server:
18+
1. **Edit JSON**: Load or paste your JSON file into the Monaco Editor.
19+
2. **Select Language**: Specify the language you want to translate your JSON content into.
20+
3. **Translate**: Click the **Translate** button to translate the JSON file into the specified language.
21+
4. **Save**: Use `Ctrl + S` to save your translated JSON file.
22+
23+
## Installation
624

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
25+
1. Clone the repository:
1626

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
27+
```bash
28+
git clone https://github.com/syntaxbox/jsont.git
29+
```
1830

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
31+
2. Install dependencies:
2032

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
33+
```bash
34+
npm install
35+
```
2236

23-
## Learn More
37+
3. Run the project:
2438

25-
To learn more about Next.js, take a look at the following resources:
39+
3.1 Dev Server:
2640

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
41+
```bash
42+
npm run dev
43+
```
2944

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
45+
3.2 Production Server:
3146

32-
## Deploy on Vercel
47+
```bash
48+
npm run build && npm start
49+
```
3350

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
51+
## Contributing
3552

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
53+
Contributions are welcome! If you’d like to contribute to **jsont**.

0 commit comments

Comments
 (0)