Readme update for 0.1

Author: matsoftware

README.md

@@ -1,2 +1,39 @@
 # swift-arch-analyzer
+
 Architectural analyzer for Swift projects.
+
+## Introduction
+
+The goal of this software is to provide an insight of the architectural state of a software written in `Swift` that consists in several modules. 
+Inspired by the book of Robert C. Martin, _Clean Architecture_, the software will scan the project to identify the different components in order to assess:
+- the overall number of concrete classes and interfaces
+- the _instability_ and _abstractness_ of the framework
+- the _distance from the main sequence_
+
+## Requirements
+
+This is a _python3_ script that depends on _matplotlib_ (`pip3 install matplotlib`).
+
+## Usage
+
+The syntax is:
+
+`python3 swift-project-archlint.py <path-to-swift-project> <excluded-folders> <output-directory>`
+
+- `<path-to-swift-project>` is the path to the folder that contains the main Xcode project or Workspace
+- `<excluded-folders>` (optional) list of subdirectories to exclude from analysis (e.g. `ThirdParty`, `Carthage` checkouts, `Pods` etc..)
+- `<output-directory>` (optional) path to the folder that will contain the generated textual analysis and graphs; if empty, the software will show the images to the user
+
+## Current limitations
+
+This tool is designed for medium/large codebases composed by different frameworks. The script will scan the directory and it will identify the frameworks by the name of the 'root' folder, so it's strictly dependent on the file hierarchy.
+
+Libraries built with `spm` are not supported.
+
+## Current state
+
+Work in progress
+
+## Contact
+
+[Mattia Campolese](https://www.linkedin.com/in/matcamp/)