Add project details to the README (elyra-ai#44)

Author: bourdakos1

README.md

@@ -15,4 +15,46 @@ See the License for the specific language governing permissions and
 limitations under the License.
 {% endcomment %}
 -->
-# pipeline-editor
+<h1 align="center">Elyra Pipeline Editor</h1>
+
+<p align="center">
+  <img alt="Pipeline Editor" src="./images/banner.svg">
+</p>
+
+<p align="center">
+  A react component for editing pipeline files. Used across all Elyra applications and browser extensions.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@elyra/pipeline-editor"><img alt="NPM Status" src="https://img.shields.io/npm/v/@elyra/pipeline-editor.svg?style=flat"></a>
+  <a href="https://github.com/elyra-ai/pipeline-editor/actions?query=branch%3Amaster+workflow%3AElyra%20Pipeline%20Editor%20Tests"><img alt="Test Status" src="https://github.com/elyra-ai/pipeline-editor/workflows/Elyra%20Pipeline%20Editor%20Tests/badge.svg?branch=master"></a>
+</p>
+
+## Installation
+
+`@elyra/pipeline-editor` is available as an [npm package](https://www.npmjs.com/package/@elyra/pipeline-editor):
+
+```sh
+// npm
+npm install @elyra/pipeline-editor
+
+// yarn
+yarn add @elyra/pipeline-editor
+```
+
+Or can be linked locally:
+```sh
+git clone [email protected]:elyra-ai/pipeline-editor.git
+cd pipeline-editor
+
+make clean install link
+```
+
+## Usage
+```jsx
+import { PipelineEditor } from '@elyra/pipeline-editor';
+
+function App() {
+  return <PipelineEditor />;
+}
+```