Initial files

1 files changed, 55 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d1086ff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# Generate Doxygen Comments fro VSCode
+
+This VSCode Extensions provides Doxygen Documentation generation on the fly by starting a Doxygen comment block and pressing enter.
+
+[![Build Status](https://travis-ci.org/christophschlosser/docdoxgen.svg?branch=master)](https://travis-ci.org/christophschlosser/docdoxgen-test)
+
+## Features
+
+Generate Doxygen Comments from method signatures.
+
+From simple setter methods
+
+![Simple Parameter](images/param_simple.gif)
+
+over declarations
+
+![Declaration](images/declaration.gif)
+
+to bool return values.
+
+![Bool return val](images/bool.gif)
+
+And some special cases:
+
+Like Constructors
+
+![Constructor](images/ctor.gif)
+
+Defintions in header files
+
+![definition](images/definition.gif)
+
+Multi line definitions/declarations
+
+![method](images/method.gif)
+
+Or void return values
+
+![void](images/void.gif)
+
+## Extension Settings
+
+See [Below](#whats-to-come)
+
+## Known Issues
+
+Completely new extension, so none.
+
+## What's to come
+
+* Suggest smart text
+
+* Configuration options
+
+* Tests
\ No newline at end of file