Add README

Author: alex35mil

NeoHub.xcodeproj/project.pbxproj

@@ -104,6 +104,7 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		FA03D4C82AFA302A00790D2F /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
 		FA2AE4472AEB980700D24008 /* NeoHub.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = NeoHub.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		FA2AE44A2AEB980700D24008 /* App.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = App.swift; sourceTree = "<group>"; };
 		FA2AE44E2AEB980800D24008 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
@@ -174,6 +175,7 @@
 		FA2AE43E2AEB980700D24008 = {
 			isa = PBXGroup;
 			children = (
+				FA03D4C82AFA302A00790D2F /* README.md */,
 				FA2AE4492AEB980700D24008 /* NeoHub */,
 				FA2AE45E2AEB9CA000D24008 /* NeoHubCLI */,
 				FA2EADA32AED589F000F8F7A /* NeoHubLib */,

README.md

@@ -0,0 +1,40 @@
+<h1 align="center">NeoHub</h1>
+
+<p align="center">
+    <img width="600" alt="NeoHub" src="https://user-images.githubusercontent.com/4244251/281020657-ab8ceed5-8b4e-4366-89e0-4640b1887c2c.png">
+</p>
+
+## Why?
+[Neovide](https://neovide.dev/) is a sweeeeet GUI for [Neovim](https://neovim.io/), but I had two annoying issues.
+1. When multiple instances are running, it is hard to switch between them as each instance is a separate macOS process, and all the processes are named `neovide` in the `⌘ ⇥` list.
+2. Often, I accidentally run a project that is already running, resulting in a Neovim error related to existing swap files.
+
+## Features
+So, what NeoHub offers?
+1. Global hotkey that shows a switcher between Neovide instances. You can hit this hotkey from anywhere and activate a project you need.
+2. CLI, which executes new Neovide instances, and if an instance at the current path is already running, it activates it instead of spawning a new one.
+
+## Requirements
+- `macOS 13+`.
+- Administrative privileges to install the CLI.
+- `neovide` available in your `PATH`.
+
+## Download
+Get it from the [Releases](https://github.com/alex35mil/NeoHub/releases).
+
+## Usage
+On the very first launch, you will be asked to install the CLI. This is the only way to launch a Neovide through the NeoHub.
+
+Once installed, the `neohub` command should become available in your shell. Use it instead of `neovide` to launch editors. Otherwise, things won't work.
+
+Hit `⌘ ⌃ N` (`Command + Control + N`) to open the switcher (hotkey is configurable).
+
+P.S. If only one Neovide instance is running, NeoHub will activate it instead of showing the switcher.
+
+Also, you can quit all editors at once by pressing `⌘ Q` in the switcher, or just a selected one with `⌘ ⌫`.
+
+## Credits
+App icon is by [u/danbee](https://www.reddit.com/user/danbee/).
+
+## License
+MIT.