add readme outline

README.md

@@ -1 +1,47 @@
-# java-variance
+# Java Variance
+
+![Build Status](https://img.shields.io/github/workflow/status/bldl/java-variance/CI) ![License](https://img.shields.io/github/license/bldl/java-variance)
+
+## Description
+
+This is a project that incorporates Java annotations in order to allow specification of different generic parameter variances.
+
+## Table of Contents
+
+- [Installation](#installation)
+  - [Prerequisites](#prerequisites)
+  - [For maven users](#for-maven-users)
+  - [For grade users](#for-gradle-users)
+  - [For other users](#for-other-users)
+- [Usage](#usage)
+  - [Subsection](#subsection)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+### Prerequisites
+
+### For maven users
+
+<!-- TODO: Add when project is published to maven central -->
+
+### For gradle users
+
+<!-- TODO: Add when project is published to maven central -->
+
+### For other users
+
+```bash
+$ git submodule add https://github.com/bldl/java-variance
+```
+
+## Usage
+
+### Subsection
+
+## Contributing
+
+Pull requests and issues that aim to better the project are greatly appreciated.
+
+## License