chore: add docc folder

SwiftAutoGUI.docc/SwiftAutoGUI.md

@@ -0,0 +1,80 @@
+# ``SwiftAutoGUI``
+
+A library for manipulating macOS with Swift, which is used to programmatically control the mouse & keyboard.
+
+# Installation
+
+## Swift Package Manager
+SwiftAutoGUI is available through [Swift Package Manager](https://www.swift.org/package-manager/).
+
+in `Package.swift` add the following:
+
+```swift
+dependencies: [
+    // Dependencies declare other packages that this package depends on.
+    .package(url: "https://github.com/NakaokaRei/SwiftAutoGUI", branch: "master")
+],
+targets: [
+    .target(
+        name: "MyProject",
+        dependencies: [..., "SwiftAutoGUI"]
+    )
+    ...
+]
+```
+
+## CocoaPods
+SwiftAutoGUI is available through [CocoaPods](https://cocoapods.org/).
+
+in `Podfile` add the following:
+
+```ruby
+pod 'SwiftAutoGUI'
+```
+
+# Example Usage
+
+If you would like to know more details, please refer to the [DocC Style Document](https://nakaokarei.github.io/SwiftAutoGUI/documentation/swiftautogui/).
+
+## Keyboard
+
+By calling a method of the SwiftAutoGUI class as shown below, you can send key input commands to macOS. Supported keys are written in [Keycode.swift](/Sources/SwiftAutoGUI/Keycode.swift).
+
+As shown in the sample below, you can also input shortcuts, such as moving the virtual desktop by sending the command `ctrl + ←`.
+
+Currently ***only US keyboards*** are supported. Otherwise, it may not work properly.
+
+```swift
+import SwiftAutoGUI
+
+// Send ctrl + ←
+SwiftAutoGUI.sendKeyShortcut([.control, .leftArrow])
+
+// Send sound up
+SwiftAutoGUI.keyDown(.soundUp)
+SwiftAutoGUI.keyUp(.soundUp)
+```
+
+## Mouse
+Similarly, mouse operations can generate basic commands such as mouse movement, clicking, and scrolling by invoking methods of the SwiftAutoGUI class.
+
+```swift
+import SwiftAutoGUI
+
+// Move mouse by dx, dy from the current location
+SwiftAutoGUI.moveMouse(dx: 10, dy: 10)
+
+// Move the mouse to a specific position
+// This parameter is the `CGWindow` coordinate.
+SwiftAutoGUI.move(to: CGPointMake(0, 0))
+
+// Click where the mouse is located
+SwiftAutoGUI.leftClick() // left
+SwiftAutoGUI.rightClick() // right
+
+// Scroll
+SwiftAutoGUI.vscroll(clicks: 10) // up
+SwiftAutoGUI.vscroll(clicks: -10) // down
+SwiftAutoGUI.hscroll(clicks: 10) // left
+SwiftAutoGUI.hscroll(clicks: -10) // right
+```