Skip to content

Commit f663b8e

Browse files
committed
update readme
1 parent 5c1c5ef commit f663b8e

File tree

1 file changed

+46
-9
lines changed

1 file changed

+46
-9
lines changed

README.md

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,24 +53,61 @@ litepost/
5353
└── public/ # Static assets
5454
```
5555

56-
## Features
56+
## Features 🚀
5757

58-
- Modern, native UI built with React, Tailwind CSS, and Shadcn UI
59-
- Cross-platform support (Windows, macOS, Linux)
60-
- API request history
61-
- Multiple request tabs
62-
- Custom request headers and parameters
63-
- Response preview
58+
- 🎨 Modern, native UI built with React, Tailwind CSS, and Shadcn UI
59+
- 💻 Cross-platform support (Windows, macOS, Linux)
6460

65-
## Contributing
61+
### Request & Authentication 🔐
62+
- Multiple request tabs with history
63+
- Authentication support:
64+
- Basic Auth
65+
- Bearer Token
66+
- API Key (header and query parameter)
67+
- Custom request headers and parameters
68+
- 📝 Code generation for multiple languages (curl, Python, JavaScript, C#, Go, Ruby)
69+
70+
### Response Handling 📊
71+
- Advanced response visualization:
72+
- ✨ JSON prettification with syntax highlighting
73+
- 📄 XML formatting
74+
- 🌐 HTML preview
75+
- 🖼️ Image preview
76+
- Response metrics:
77+
- 📏 Size measurements
78+
- ⚡ Request/response timing
79+
- 📈 Network timing breakdown (DNS, First byte, Download time)
80+
81+
### Environment Management 🌍
82+
- Create, edit, and delete environments
83+
- Variable substitution
84+
- Environment switching
85+
- Environment-specific variables
86+
87+
### Collections 📁
88+
- Save and organize requests in collections
89+
- Basic folder organization
90+
- Import/export collections
91+
- Postman format compatibility
92+
93+
### Testing ✅
94+
- JavaScript-based test scripts
95+
- Comprehensive test assertions:
96+
- Status code validation
97+
- JSON value verification
98+
- Header checks
99+
- Response time validation
100+
- Test execution with results display
101+
102+
## Contributing 🤝
66103

67104
1. Fork the repository
68105
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
69106
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
70107
4. Push to the branch (`git push origin feature/amazing-feature`)
71108
5. Open a Pull Request
72109

73-
## License
110+
## License ⚖️
74111

75112
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This means:
76113

0 commit comments

Comments
 (0)