Skip to content

Commit 90210ef

Browse files
docs: Enhance README with a new header, badges, and clearer getting started steps, and bump the package version.
1 parent f3ef0a5 commit 90210ef

2 files changed

Lines changed: 27 additions & 31 deletions

File tree

README.md

Lines changed: 26 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
1-
# API Documenter
1+
<div align="center">
2+
<img src="resources/icon.jpg" alt="API Documenter Logo" width="150" />
23

3-
**API Documenter** is a powerful, self-hosted, offline-first alternative to Postman and Insomnia. It is designed for developers who need a robust API testing environment that works locally by default but scales into a team-oriented platform with secure database synchronization and granular access control.
4+
<h1>API Documenter</h1>
45

5-
![API Documenter](resources/icon.png)
6+
<p>
7+
<strong>A powerful, self-hosted, offline-first alternative to Postman and Insomnia.</strong>
8+
</p>
69

7-
## Key Features
10+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
11+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
12+
</div>
13+
14+
---
15+
16+
**API Documenter** is designed for developers who need a robust API testing environment that works locally by default but scales into a team-oriented platform with secure database synchronization and granular access control.
17+
18+
## ✨ Key Features
819

920
- **Offline-First Desktop Environment**: Local performance with no cloud dependency for personal projects.
1021
- **Secure Team Workspaces**: Connect to **PostgreSQL** or **MySQL** for team synchronization via a secure Vercel-hosted proxy.
@@ -13,51 +24,36 @@
1324
- **Premium Responsive UI**: A dark-themed, premium design with a custom font-scaling engine for perfect readability on any screen.
1425
- **Automated Updates**: Integrated GitHub update system for seamless version management.
1526

16-
## Built With
27+
## 🛠️ Built With
1728

1829
- **Core**: Electron, React, TypeScript, Vite
1930
- **Database**: mysql2, pg, Dexie (IndexedDB)
2031
- **Styling**: Vanilla CSS (Custom Variable-based Scaling)
2132
- **Deployment**: Vercel & GitHub Actions
2233

23-
## Getting Started
34+
## 🚀 Getting Started
2435

2536
### Prerequisites
2637

38+
Ensure you have the following installed on your local machine:
2739
- [Node.js](https://nodejs.org/) (v18 or higher)
2840
- [npm](https://www.npmjs.com/)
2941

30-
### Installation
42+
### Installation & Setup
3143

32-
1. Clone the repository:
44+
1. **Clone the repository:**
3345
```bash
3446
git clone https://github.com/PraneethKulukuri26/API-Documenter.git
3547
cd API-Documenter
36-
```
37-
38-
2. Install dependencies:
48+
2. **Install dependencies:**
3949
```bash
4050
npm install
41-
```
42-
43-
3. Start development server:
51+
3. **Run the application:**
4452
```bash
4553
npm run dev
46-
```
47-
48-
4. Build for production:
54+
4. **Build for production:**
4955
```bash
5056
npm run build
51-
```
52-
53-
## Contributing
54-
55-
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
56-
57-
## License
58-
59-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
60-
61-
## Security
62-
63-
If you discover any security-related issues, please refer to [SECURITY.md](SECURITY.md) for reporting instructions.
57+
5. **Deploy to Vercel:**
58+
```bash
59+
npm run deploy

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "api-documenter",
3-
"version": "1.0.15",
3+
"version": "1.0.16",
44
"description": "Self-hosted Postman alternative with folder-level RBAC and offline-first documentation",
55
"main": "./out/main/index.js",
66
"author": "Praneeth Kulukuri",

0 commit comments

Comments
 (0)