create README.md

README.md

@@ -0,0 +1,44 @@
+# [Name](http://repolink.io)
+It should be linked to the Github domain
+
+<a href="http://respolink.io"><img src="https://assets-cdn.github.com/images/modules/open_graph/github-mark.png" alt="Name: A software" style="max-width:100%;" width="400" height="215"></a>
+
+
+## Synopsis
+
+At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions of repository
+
+## Motivation
+
+A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.
+
+## Quick install
+
+Provide code examples and explanations of how to get the project.
+
+## Plugins and Extensions
+
+Provide additional plugins for the software
+
+## Platform Support
+OS system should be described. and the system configuration should also be mentioned in this
+
+## Tests
+
+Describe and show how to run the tests with code examples.
+
+## Related projects
+Projects that is linked with this repository or software should be mentioned
+
+| Project                                                                            | Description                                                        |
+|------------------------------------------------------------------------------------|--------------------------------------------------------------------|
+| [Project Name](https://github.com/) | Description.                        |
+
+
+## Contributors
+
+Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
+
+## Copyright and license
+
+A short snippet describing the license (MIT, Apache, etc.)