Merge pull request #14 from sebastian-muthwill/main

integrate README.md changes to staging

README.md

@@ -2,7 +2,7 @@
 
 PowerApps-docstring is a console based, pipeline ready application that automatically generates user and technical documentation for PowerApps.
 
-**Currently in "call for demands/ideas" stage**
+[v0.1.0-alpha version available](https://github.com/sebastian-muthwill/powerapps-docstring/releases/tag/v0.1.0-alpha)
 
 ## Purpose of this application
 Documentation of Microsoft Power Apps is an important building block in the software lifecycle. As in the traditional software development process, the developed Power App should also be documented propperly to ensure further development/support and maintenance as well as onboarding of new developers.
@@ -15,6 +15,11 @@ This application shall solve this problem by providing a way to:
 - integrate the documentation creation process into the ci/cd pipeline aswell as
 - create documentation based on an exported app
 
+## Getting started
+1. clone repository `git clone https://....` and change into directory `cd powerapps-docstring`
+2. install requirements with `pip install -r requirements.txt`
+3. run with `python3 main.py -s path/to/src/folder -o path/to/output/folder`
+
 ## Feature ideas
 If you would like to submit your idea, please comment this issue: https://github.com/sebastian-muthwill/powerapps-docstring/issues/1
 
@@ -34,10 +39,6 @@ If you would like to submit your idea, please comment this issue: https://github
   - src
 - usable via Azure DevOps CI-CD pipeline
 
-## Todos
-- collect ideas
-- create first alpha version
-
 ## Follow this topic
 [Twitter](https://twitter.com/waszumkuckuck)