Добавил Readme

README.md

@@ -1,2 +1,43 @@
-# mutanus
-Performs mutation testing of your Swift project
+# Mutanus
+Command line tool written in Swift dedicated to perform Mutation Testing of your Swift project.
+Inspired by [Muter](https://github.com/muter-mutation-testing/muter)
+
+# Usage
+
+ ```
+ mutanus -c <path-to-config>
+ ```
+
+- Required
+
+  - **executable** - used for builing your project 
+  - **arguments** - array of executable arguments to run tests of your project
+
+- Optional
+
+  - **project_path** - path to the root of your project. Current directory is used if not present
+  - **source_paths** - array of relative to **project_path** paths  of files or/and folders. Listed sources are used for mutants search. All files in **project_path** are used if not present
+
+
+
+```json
+{ 
+	"executable": "/usr/bin/xcodebuild",
+	"arguments": [
+		"test",
+        "-workspace",
+        "MyWorkspace.xcworkspace",
+        "-scheme",
+        "MyScheme",
+        "-destination",
+        "platform=iOS Simulator,name=iPhone 8",
+        "SWIFT_TREAT_WARNINGS_AS_ERRORS=NO",
+        "GCC_TREAT_WARNINGS_AS_ERRORS=NO"
+	],
+	"project_path": "<path-to-project>",
+	"source_paths": [ 
+		"<path-to-first-souce-file>",
+		"<path-to-second-souce-file>"
+	]
+}
+```