46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# ShortMenu
|
|
|
|
ShortMenu is a macOS application built with SwiftUI that allows users to shorten URLs. It provides a convenient way to generate shorter, more manageable links for sharing.
|
|
|
|
## Features
|
|
|
|
- Shorten URLs: Enter a long URL and click the "ShortURL" button to generate a shortened version.
|
|
- Define API Key: Click the "Define API Key" button to open a modal window where you can enter your API key. The key will be stored securely in the macOS Keychain.
|
|
|
|
## Requirements
|
|
|
|
- macOS 10.15 or later
|
|
|
|
## Installation
|
|
|
|
1. Clone the repository:
|
|
```
|
|
git clone https://gitea.louisgallet.fr/lgallet/short-menu.git
|
|
```
|
|
2. Open the project in Xcode.
|
|
|
|
3. Build and run the project in Xcode.
|
|
|
|
## Usage
|
|
1. Launch the ShortMenu application.
|
|
|
|
2. Copy the long URL you want to shorten.
|
|
|
|
3. Click the "ShortURL" button to shorten a URL.
|
|
|
|
4. If you haven't defined an API key yet, click the "Define API Key" button. Enter your API key in the provided text field and click "Save".
|
|
|
|
5. Paste the long URL everywhere you want to share it.
|
|
|
|
## License
|
|
|
|
[MIT License](LICENSE)
|
|
|
|
## Acknowledgements
|
|
|
|
ShortMenu is built using SwiftUI and makes use of the [Short.io API](https://short.io) API for URL shortening.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! If you have any suggestions or feature requests, please open an issue or submit a pull request.
|