feat: implement menubar app

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2022 Victor Aremu
+
+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.

README.md

@@ -1,7 +1,52 @@
-# Tauri + React + Typescript
+# Tauri macOS Menubar App Example
 
-This template should help get you started developing with Tauri, React and Typescript in Vite.
+This is an example project that shows how to create a macOS Menubar app using Tauri.
+
+This template is based on Tauri + React + Typescript template. It should help get you started developing with Tauri, React and Typescript in Vite.
+
+## Prerequisites
+
+- _[<ins>Node.js<ins>](https://nodejs.org)_
+- _[<ins>Tauri CLI<ins>](https://tauri.studio/docs/getting-started/installation)_
+
+## Getting Started
+
+1. Clone this repository:
+
+```
+git clone https://github.com/ahkohd/tauri-macos-menubar-app-example.git
+```
+
+2. Navigate to the project directory:
+
+```
+cd tauri-macos-menubar-app-example
+```
+
+3. Run the demo
+
+```
+pnpm install
+pnpm tauri dev
+```
+
+5. Go to your menubar, click the Tauri tray icon.
+
+## Demo
+
+![Demo](./demo.gif)
 
 ## Recommended IDE Setup
 
 - [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
+
+# Related
+
+The following are related to this project:
+
+- [tauri-nspanel](https://github.com/ahkohd/tauri-nspanel/tree/main/examples/vanilla): A Tauri plugin that enables the transformation of a standard application window into a panel, providing panel-specific functionalities and methods. It is designed for versatile application across various projects.
+- [tauri-plugin-spotlight](https://github.com/zzzze/tauri-plugin-spotlight): Also a Tauri plugin that helps you to emulate a spotlight window behavior. Unlike the `tauri-nspanel` or this example project, it does not utilize a panel. As a result, its ability to draw over fullscreen applications on newer macOS versions may be limited.
+
+# License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE.md) file for details.

renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}