Skip to content

Commit 476603e

Browse files
committed
Docs Updates
1 parent 605c154 commit 476603e

File tree

3 files changed

+24
-22
lines changed

3 files changed

+24
-22
lines changed

README.md

+21-19
Original file line numberDiff line numberDiff line change
@@ -10,37 +10,38 @@ An open-source tool for developers to generate TypeScript types from JSON object
1010

1111
- **Fast Conversion**: Generate TypeScript interfaces from JSON in seconds.
1212
- **Nested Objects Support**: Handles deeply nested structures with ease.
13+
- **Array Depth Detection**: Automatically detects array depth and types.
14+
- **ISO Date Recognition**: Converts valid ISO date strings to `Date` type.
1315
- **Secure Offline Use**: No need to paste your data online—works locally.
14-
- **Customizable**: Future support for advanced type handling and customizations.
16+
- **Customizable Future Enhancements**: Support for advanced type handling and customizable options in future updates.
1517

1618
---
1719

1820
## 📦 Installation
1921

20-
Install the package via NPM:
22+
You can install the package globally using any of these package managers:
2123

24+
**Using NPM:**
2225
```bash
2326
npm install -g @typeweaver/json2ts
2427
```
2528

26-
---
27-
28-
## 🛠️ Usage
29-
30-
### CLI
31-
Convert a JSON file to a TypeScript interface:
32-
29+
**Using Yarn:**
3330
```bash
34-
json2ts convert input.json output.ts
31+
yarn global add @typeweaver/json2ts
3532
```
3633

37-
Or use JSON from the clipboard:
38-
34+
**Using PNPM:**
3935
```bash
40-
json2ts --clipboard
36+
pnpm add -g @typeweaver/json2ts
4137
```
4238

39+
---
40+
41+
## 🛠️ Usage
42+
4343
### Programmatic API
44+
4445
Import and use the package in your Node.js or TypeScript project:
4546

4647
```typescript
@@ -61,7 +62,7 @@ console.log(tsInterface);
6162

6263
## ✨ Example
6364

64-
Input JSON:
65+
### Input JSON:
6566
```json
6667
{
6768
"name": "John",
@@ -73,7 +74,7 @@ Input JSON:
7374
}
7475
```
7576

76-
Generated TypeScript Interface:
77+
### Generated TypeScript Interface:
7778
```typescript
7879
interface Root {
7980
name: string;
@@ -89,14 +90,14 @@ interface Root {
8990

9091
## 📚 Documentation
9192

92-
For detailed documentation and examples, visit the [project wiki](https://github.com/glincker/json-to-typescript/wiki).
93+
For more details, advanced examples, and troubleshooting, check the [project wiki](https://github.com/glincker/json-to-typescript/wiki).
9394

9495
---
9596

9697
## 🤝 Contributing
9798

9899
We welcome contributions!
99-
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines.
100+
If you want to enhance this project, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines.
100101

101102
---
102103

@@ -109,10 +110,11 @@ This project is licensed under the [MIT License](LICENSE).
109110
## 🌟 Acknowledgments
110111

111112
- Developed by [Glincker](https://github.com/glincker).
112-
- Part of the **TypeWeaver** ecosystem.
113+
- Part of the **GLINR** ecosystem.
113114

114115
---
115116

116117
## 📬 Feedback
117118

118-
Have ideas or suggestions? Create an issue in the repository or join the discussion on [GLINR Community](https://community.glinr.dev).
119+
We’d love to hear from you!
120+
Submit your ideas or suggestions via issues in the repository or join the discussion on the [GLINR Community](https://community.glinr.dev).

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@typeweaver/json2ts",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "Convert JSON to TypeScript interfaces effortlessly. An open-source tool for developers to generate TypeScript types from JSON objects quickly and securely.",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)