release-1.0.0

.gitignore

@@ -70,6 +70,8 @@ fastlane/Preview.html
 fastlane/screenshots/**/*.png
 fastlane/test_output
 
+**/.DS_Store
+
 # Code Injection
 #
 # After new code Injection tools there's a generated folder /iOSInjectionProject

README.md

@@ -1,2 +1,49 @@
 # MaClicker
- A simple auto clicker for your Mac.
+MaClicker is a simple auto clicker for your Mac. It was built with swift and requires macOS 10.12 Sierra or higher. It is possible to achieve up to 100 clicks per second.
+<br>
+![](images/program.png)
+<br>
+Two languages are currently supported:
+- English
+- German
+
+## Usage
+
+### Installation
+Download the .dmg file [of the release page](https://github.com/WorldOfBasti/MaClicker/releases), open it and copy the .app file to your applications folder. Open it, it should pop up in your menubar. Don't forget to add MaClicker to the accessibility permissions in the System Preferences: <br>
+System Preferences -> Security & Privacy -> Privacy -> Accessibility
+
+### Select mode
+Currently, you can choose between two modes:
+- Klick <br>
+The click mode enables the auto clicker with the specified clicks per second on the selected mouse button.
+- Hold <br>
+The hold mode simply holds the selected mouse button.
+
+### Select activation key
+You need to select a hotkey to toggle the auto clicker.
+
+### Select mouse button
+Currently, you can choose between two mouse buttons to use:
+- Left mouse button
+- Right mouse button <br>
+
+### Select clicks per second (click speed)
+You can select how many clicks per second should be pressed.
+
+### Select click limit
+You can enable and set a click limit. The auto clicker stops when the limit got reached.
+
+## Building
+If you want to build MaClicker from source, follow these steps:
+- Check if [cocoapods](https://cocoapods.org) are installed, if not install it with: `sudo gem install cocoapods` in your terminal
+- Download the source code
+- Open the src folder in your terminal and type: `pod install`
+- Open the `MaClicker.xcworkspace` file with xCode
+- Build the project
+
+## Acknowledgements
+Thanks to [the Sauce project](https://github.com/Clipy/Sauce), it helps me [translating a keyCode to the actual key name](https://github.com/WorldOfBasti/MaClicker/blob/master/src/MaClicker/KeyCodeToKeyTransformer.swift).
+
+## Want to support this project?
+The best way to support this project is to create issues and sending pull requests. Alternatively, you can translate the program to [other languages](https://github.com/WorldOfBasti/MaClicker/blob/master/src/MaClicker/en.lproj/Main.storyboard).