README.md committed

README.md

@@ -0,0 +1,57 @@
+# Project Name
+
+(short, 1-3 sentenced, description of the project)
+
+## Features
+
+This project framework provides the following features:
+
+* Feature 1
+* Feature 2
+* ...
+
+## Getting Started
+
+### Prerequisites
+
+(ideally very short, if any)
+
+- OS
+- Library version
+- ...
+
+### Installation
+
+(ideally very short)
+
+- npm install [package name]
+- mvn install
+- ...
+
+### Quickstart
+(Add steps to get up and running quickly)
+
+1. git clone [repository clone url]
+2. cd [repository name]
+3. ...
+
+
+## Demo
+
+A demo app is included to show how to use the project.
+
+To run the demo, follow these steps:
+
+(Add steps to start up the demo)
+
+1.
+2.
+3.
+
+## Resources
+
+(Any additional resources or related projects)
+
+- Link to supporting information
+- Link to similar sample
+- ...