Update README (#16)

* first pass at an updated readme

* Update README.md

Co-authored-by: Elijah Wilson <[email protected]>

Co-authored-by: Elijah Wilson <[email protected]>

Author: rohitsanj

README.md

@@ -1,25 +1,58 @@
-# origami
+# Origami
 A library capturing message patterns and protocols speaking to Noteable's APIs
+<p align="center">
+<a href="https://github.com/noteable-io/origami/actions/workflows/ci.yaml">
+    <img src="https://github.com/noteable-io/origami/actions/workflows/ci.yaml/badge.svg" alt="CI" />
+</a>
+<a href="https://codecov.io/gh/noteable-io/origami" > 
+ <img src="https://codecov.io/gh/noteable-io/origami/branch/main/graph/badge.svg" alt="codecov code coverage"/> 
+ </a>
+<img alt="PyPI - License" src="https://img.shields.io/pypi/l/noteable-origami" />
+<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/noteable-origami" />
+<img alt="PyPI" src="https://img.shields.io/pypi/v/noteable-origami">
+<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+</p>
 
-# Connect
+---------
 
-1. Get your access token from https://app.noteable.world/api/token
-2. Test connection -
+[Install](#installation) | [Getting Started](#getting-started) | [License](./LICENSE) | [Code of Conduct](./CODE_OF_CONDUCT.md) | [Contributing](./CONTRIBUTING.md)
+
+## Requirements
+
+Python 3.8+
+
+## Installation
+
+### Poetry
+
+```shell
+poetry add noteable-origami
+```
+
+
+### Pip
+```shell
+pip install noteable-origami
+```
+
+## Getting Started
+
+Get your access token from https://app.noteable.world/api/token
 
 ```python
 from origami.client import NoteableClient
 
 token = 'ey...' # from https://app.noteable.world/api/token
 async with NoteableClient(api_token=token) as client:
     await client.ping_rtu()
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+-------
+
+<p align="center">Open sourced with ❤️ by <a href="https://noteable.io">Noteable</a> for the community.</p>
 
->>> 2022-05-23 10:49.18 [error    ] No config object passed in and no config file found at ./auth0_config, using default empty config
-    2022-05-23 10:49.18 [debug    ] Sending websocket request: transaction_id=UUID('dad3b403-fee6-401a-86f8-244e928db684') event='authenticate_request' channel='system' data=AuthenticationRequestData(token='e...')
-    2022-05-23 10:49.18 [debug    ] Received websocket message: executing_user_id=None transaction_id=UUID('dad3b403-fee6-401a-86f8-244e928db684') msg_id=UUID('c13ae73d-aa4b-406e-930a-fb79611c58fc') event='authenticate_reply' channel='system' data={'success': True, 'user': {...}} processed_timestamp=datetime.datetime(2022, 5, 23, 15, 16, 11, 533877, tzinfo=datetime.timezone.utc)
-    2022-05-23 10:49.18 [debug    ] Found callable for system/dad3b403-fee6-401a-86f8-244e928db684
-    2022-05-23 10:49.18 [debug    ] User is authenticated!
-    2022-05-23 10:49.18 [debug    ] Sending websocket request: transaction_id=UUID('3963312a-eb9a-48e6-88a8-e7a062382419') event='ping_request' channel='system' data=None
-    2022-05-23 10:49.18 [debug    ] Received websocket message: executing_user_id=None transaction_id=UUID('3963312a-eb9a-48e6-88a8-e7a062382419') msg_id=UUID('72afb144-fe9d-4fbb-b746-a73ab7a865a0') event='ping_reply' channel='system' data=None processed_timestamp=datetime.datetime(2022, 5, 23, 15, 16, 11, 625892, tzinfo=datetime.timezone.utc)
-    2022-05-23 10:49.18 [debug    ] Found callable for system/3963312a-eb9a-48e6-88a8-e7a062382419
-    2022-05-23 10:49.18 [debug    ] Intial ping response received! Websocket is live.
-```    
+<img href="https://pages.noteable.io/private-beta-access" src="https://assets.noteable.io/github/2022-07-29/noteable.png" alt="Boost Data Collaboration with Notebooks">