From c161af6c7519342883c7f6d388f9e7b15789c4cf Mon Sep 17 00:00:00 2001
From: Louis <me@louisgallet.fr>
Date: Thu, 6 Jul 2023 19:04:09 +0200
Subject: [PATCH] docs: :pencil:  Create readme and add license

---
 LICENSE   | 21 +++++++++++++++++++++
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ccee83c
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023] [Louis Galet]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3544b2a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# 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.