Skip to content

Commit 87f9964

Browse files
committed
chore(docs): Update README.md
1 parent 9635049 commit 87f9964

File tree

1 file changed

+39
-29
lines changed

1 file changed

+39
-29
lines changed

README.md

Lines changed: 39 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
</a>
55
<br>
66
<a href="https://github.com/gitset-dev/gitset-desktop" target="_blank">
7-
<img src="https://img.shields.io/static/v1?label=version&message=v1.6.0&color=7BFEF5" alt="version" />
7+
<img src="https://img.shields.io/static/v1?label=version&message=v1.9.0&color=7BFEF5" alt="version" />
88
</a>
99
</div>
1010

@@ -18,19 +18,19 @@
1818

1919
<hr>
2020

21-
**Gitset Desktop** is the official cross-platform desktop application for [Gitset.dev](https://gitset.dev) - an advanced AI-driven GitHub tools suite. This electron-based application provides a dedicated desktop experience across macOS, Windows, and Linux systems, allowing users to access all Gitset features in a native application environment.
21+
**Gitset Desktop** is the official cross-platform desktop application for [Gitset.dev](https://gitset.dev) - an advanced AI-driven GitHub tools suite. This Electron-based application provides a dedicated desktop experience across macOS, Windows, and Linux systems, allowing users to access all Gitset features in a native application environment with seamless token synchronization.
2222

23-
## Features
23+
### Features
2424

2525
- **Cross-Platform Support**: Runs natively on macOS, Windows, and Linux
2626
- **Seamless Integration**: Provides the complete Gitset.dev experience in a dedicated desktop environment
27-
- **Custom Window Controls**: Platform-specific window controls for a native experience
28-
- **Offline Capability**: Access to cached content even when offline
29-
- **System Integration**: Native notifications and system tray integration
27+
- **Native Window Controls**: Platform-specific window controls with proper drag and resize functionality
28+
- **Shared Token System**: Synchronized token usage with the web application across all platforms
29+
- **System Integration**: Native notifications and platform-optimized interface
3030

31-
## Technical Architecture
31+
### Technical Architecture
3232

33-
Gitset Desktop is built with Electron, providing a consistent experience across all supported platforms while maintaining native OS integrations. The application wraps the Gitset.dev web application in a desktop environment, with custom window management and menu options.
33+
Gitset Desktop is built with Electron, providing a consistent experience across all supported platforms while maintaining native OS integrations. The application wraps the Gitset.dev web application in a desktop environment with optimized performance.
3434

3535
```
3636
├── main.js # Main electron process
@@ -39,23 +39,32 @@ Gitset Desktop is built with Electron, providing a consistent experience across
3939
└── icons/ # Application icons for different platforms
4040
```
4141

42-
## Installation
42+
### Installation
4343

44-
### Prerequisites
44+
#### Prerequisites
4545

4646
- Node.js (v16.x or later)
4747
- npm (v7.x or later)
4848

49-
### Development Setup
49+
#### Development Setup
5050

5151
1. Clone the repository:
5252
```bash
5353
git clone https://github.com/gitset-dev/gitset-desktop.git
5454
cd gitset-desktop
5555
```
5656

57+
2. Install dependencies:
58+
```bash
59+
npm install
60+
```
61+
62+
3. Start the development server:
63+
```bash
64+
npm start
65+
```
5766

58-
### Building Installers
67+
#### Building Installers
5968

6069
To build installers for all supported platforms:
6170

@@ -71,49 +80,50 @@ npm run build:win # For Windows
7180
npm run build:linux # For Linux
7281
```
7382

74-
## Technical Configuration
83+
### Platform Configuration
7584

7685
The application is configured to provide native-like experience on each platform:
7786

78-
### macOS
79-
- Uses `hiddenInset` title bar style for a more integrated experience
80-
- Includes standard macOS application menu structure
87+
#### macOS
88+
- Native title bar with proper drag functionality
89+
- Standard macOS application menu structure
8190
- Builds DMG installer
8291

83-
### Windows
84-
- Uses custom application icon
85-
- Includes standard application menus
92+
#### Windows
93+
- Custom application icon and window controls
94+
- Standard application menus
8695
- Builds NSIS installer
8796

88-
### Linux
97+
#### Linux
8998
- Supports AppImage and DEB package formats
90-
- Includes standard menu structure
99+
- Standard menu structure
91100
- Categorized as Development tool in application launchers
92101

93-
## Platform Compatibility
102+
### Platform Compatibility
94103

95104
| Platform | Supported Versions |
96105
|----------|-----------------------------------|
97106
| macOS | 10.13 (Sierra) or later |
98107
| Windows | Windows 10, Windows 11 |
99108
| Linux | Ubuntu 18.04+, Fedora 30+, etc. |
100109

101-
## Versioning
102-
Gitset Desktop maintains version parity with the web application, with both platforms sharing the same version numbers in most releases. This parallel versioning strategy is possible because the desktop application primarily serves as a wrapper for the web app with minimal platform-specific modifications. Any divergence in version numbers typically indicates desktop-specific enhancements or platform optimizations.
110+
### Versioning Strategy
111+
112+
Gitset Desktop maintains version parity with the web application, ensuring feature consistency across platforms. The desktop application serves as a native wrapper for the web platform with optimized window management and system integration. Version updates are released concurrently to maintain synchronized functionality and token system compatibility.
103113

104-
## Related Projects
114+
### Related Projects
105115

106116
- [Gitset](https://github.com/imprvhub/gitset) - The main Gitset.dev web application
107-
- [Gitset CLI](https://github.com/gitset-dev/gitset-cli) - Command-line interface for Gitset services
117+
- [Gitset MCP Agent](https://github.com/gitset-dev/gitset-mcp) - Model Context Protocol agent for terminal and IDE integration (in development)
108118

109-
## Contributing
119+
### Contributing
110120

111121
1. Fork the repository
112122
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
113123
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
114124
4. Push to the branch (`git push origin feature/AmazingFeature`)
115125
5. Open a Pull Request
116126

117-
## License
127+
### License
118128

119-
For more information regarding licensing please read the [Terms and Conditions](https://gitset.dev/terms) on the Gitset website.
129+
For more information regarding licensing please read the [Terms and Conditions](https://gitset.dev/terms) on the Gitset website.

0 commit comments

Comments
 (0)