Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RezaRafia committed Mar 21, 2024
1 parent 40fedbb commit 4626d85
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 6 deletions.
7 changes: 4 additions & 3 deletions forge.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ import { MakerRpm } from '@electron-forge/maker-rpm';
import { VitePlugin } from '@electron-forge/plugin-vite';

const config: ForgeConfig = {
// packagerConfig: {
// asar: true,
// },
packagerConfig: {
icon: '../images/icon.ico',
name: 'Speedy',
},
rebuildConfig: {},
makers: [new MakerSquirrel({}), new MakerZIP({}, ['darwin']), new MakerRpm({}), new MakerDeb({})],
publishers: [
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes
34 changes: 32 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
https://www.electron.build/icons
https://github.com/electron-react-boilerplate/electron-react-boilerplate/blob/main/package.json
# Speedy

If you are in a place that you have multiple internet connections ( WiFi, 3g, 4g, 5g, Lan, etc. ) with poor speed, you can combine them together to get a faster and more reliable connection.

## Features

- **Connection Aggregation**: Combine all available connections to maximize your internet speed.
- **Load Balancer**: To manage your cost, You can decide how much of each connection should be used.

## Screenshot

![[Speedy Screenshot](https://github.com/RezaRafia/Speedy/assets/28136738/3cee7b58-d6a6-479d-9486-bfbe4dc03e26)](screenshot.png)

## Installation

To install Speedy, download the latest release from the [Release](https://github.com/RezaRafia/Speedy/releases) section of this repository.

## Contributing

Contributions are welcome! If you have any ideas for improvements or new features, feel free to open an issue or submit a pull request. They are some suggested task in the next section.

## Todo tasks

- **Show connection speed**: For each conenction show downloading and uploading speed.
- **UI improvment**: For larger screens, The logging section should fully stretch to the bottom.
- **Real-time Monitoring**: Add real-time monitoring features to track connection speeds and performance.
- **Smart phone version**: Find a solution to export this app to use on Android & IOS.


## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
2 changes: 1 addition & 1 deletion src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const createWindow = () => {
const mainWindow = new BrowserWindow({
width: 540,
height: 800,
icon: path.join(__dirname, 'assets/icon'),
icon: path.join(__dirname, '../images/icon.ico'),
webPreferences: {
preload: path.join(__dirname, 'preload.js'),
sandbox: false,
Expand Down

0 comments on commit 4626d85

Please sign in to comment.