WIP docs updates

docs/README.md → DOCUMENTATION.md

@@ -1,47 +1,45 @@
-@pooltogether/v4-client-js / [Exports](modules.md)
+# Client Library
 
-@pooltogether/v4-client-js / [Exports](modules.md)
-
-@pooltogether/v4-client-js / [Exports](modules.md)
-
-@pooltogether/v4-client-js / [Exports](modules.md)
-
-@pooltogether/v4-client-js / [Exports](modules.md)
-
-# 💻 PoolTogether Client Library || PoolTogether V4
-
-![npm](https://img.shields.io/npm/v/@pooltogether/v4-client-js)
-![ts](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)
 ![Tests](https://github.com/pooltogether/v4-client-js/actions/workflows/main.yml/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/pooltogether/v4-client-js/badge.svg?branch=main)](https://coveralls.io/github/pooltogether/v4-client-js?branch=main)
+![ts](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)
 [![MIT license](https://img.shields.io/npm/l/@pooltogether/v4-client-js)](https://img.shields.io/npm/l/@pooltogether/v4-client-js)
-
-<img src="https://github.com/pooltogether/pooltogether--brand-assets/blob/977e03604c49c63314450b5d432fe57d34747c66/logo/pooltogether-logo--purple-gradient.png?raw=true" alt="Brand" width="200"/>
-
-[Application](https://app.pooltogether.com/) | [Contracts](https://github.com/pooltogether/v4-core) | [Documentation](https://v4.docs.pooltogether.com/) | [Draw Calculator](https://github.com/pooltogether/draw-calculator-cli) | [Utility Library](https://github.com/pooltogether/v4-utils-js) | [Static Cache](https://github.com/pooltogether/v4-draw-results)
-
-# 🏆 Quickstart
+![npm](https://img.shields.io/npm/v/@pooltogether/v4-client-js)
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://pooltogether.com/discord)
 
 This library includes a simplified interface for interacting with a v4 PoolTogether deployment. Create an instance of `PrizePoolNetwork` and use the initialized `PrizePool` and `PrizeDistributor` to begin reading and writing data to the protocol.
 
-There are several classes that provide interfaces to the different aspects of the V4 PoolTogether protocol.
+There are several classes that provide interfaces to the different aspects of the V4 PoolTogether protocol. `PrizePoolNetwork` is the main entry point. A full tutorial is available [here](/protocol/tutorials/js-client-quickstart/)
 
 - [PrizePoolNetwork](./classes/PrizePoolNetwork.md)
+
 - [PrizePool](./classes/PrizePool.md)
 - [User](./classes/User.md)
 - [PrizeDistributor](./classes/PrizeDistributor.md)
 - [DrawCalculatorApi](./classes/DrawCalculatorApi.md)
 - [ContractFactory](./classes/ContractFactory.md)
 
-## 💾 Installation
+## 💾 &nbsp; Installation
 
 This project is available as an NPM package:
 
-```bash
+```sh
+npm install @pooltogether/v4-utils-js
+```
+
+or
+
+```sh
 yarn add @pooltogether/v4-client-js
 ```
 
-## 🌱 Initialization
+The repo can be cloned from Github for contributions.
+
+```sh
+git clone https://github.com/pooltogether/v4-client-js.git
+```
+
+## 🏎️ &nbsp; Quickstart
 
 ### PrizePoolNetwork
 
@@ -93,7 +91,7 @@ const signerPrizeDistributor = new PrizeDistributor(
 )
 ```
 
-## Examples
+## 🧮 &nbsp; Examples
 
 ### Get token data for a Prize Pool
 
@@ -180,29 +178,3 @@ NOTE: Ensure the `PrizeDistributor` was initialized with a `Signer`
 ```js
 const txResponse: TransactionResponse = await prizeDistributor.claimPrizesByDraw(1)
 ```
-
-## 💻 Developer Experience
-
-### Contributing
-
-[Create an Issue](https://github.com/pooltogether/v4-utils-js/issues) to request new features.
-
-[Open Pull Request](#) adhering to Contribution guidelines.
-
-The package is setup using the [TSDX zero-config CLI](https://tsdx.io/) which includes:
-
-- Typescript
-- Rollup
-- Jest
-- Prettier
-- ESLint
-
-**Minor changes have been made to extend the default configuration.**
-
-#### ESLint
-
-The TSDX linting configuration is overwritten to include override(s)\* for:
-
-- Import/Order (used to enforce consistent module import ordering)
-
-###### \*The ESLint overrides may incorrectly be interpreted by VSCode since the nested config file is ignored in the IDE

README.md

@@ -1,37 +1,56 @@
-# 💻 PoolTogether Client Library || PoolTogether V4
+<p align="center">
+  <a href="https://github.com/pooltogether/pooltogether--brand-assets">
+    <img src="https://github.com/pooltogether/pooltogether--brand-assets/blob/977e03604c49c63314450b5d432fe57d34747c66/logo/pooltogether-logo--purple-gradient.png?raw=true" alt="PoolTogether Brand" style="max-width:100%;" width="200">
+  </a>
+</p>
+
+<br />
+
+# 💻 &nbsp; PoolTogether Client Library || PoolTogether V4
 
-![npm](https://img.shields.io/npm/v/@pooltogether/v4-client-js)
-![ts](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)
 ![Tests](https://github.com/pooltogether/v4-client-js/actions/workflows/main.yml/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/pooltogether/v4-client-js/badge.svg?branch=main)](https://coveralls.io/github/pooltogether/v4-client-js?branch=main)
+![ts](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)
 [![MIT license](https://img.shields.io/npm/l/@pooltogether/v4-client-js)](https://img.shields.io/npm/l/@pooltogether/v4-client-js)
-
-<img src="https://github.com/pooltogether/pooltogether--brand-assets/blob/977e03604c49c63314450b5d432fe57d34747c66/logo/pooltogether-logo--purple-gradient.png?raw=true" alt="Brand" width="200"/>
+![npm](https://img.shields.io/npm/v/@pooltogether/v4-client-js)
 
 [Application](https://app.pooltogether.com/) | [Contracts](https://github.com/pooltogether/v4-core) | [Documentation](https://v4.docs.pooltogether.com/) | [Draw Calculator](https://github.com/pooltogether/draw-calculator-cli) | [Utility Library](https://github.com/pooltogether/v4-utils-js) | [Static Cache](https://github.com/pooltogether/v4-draw-results)
 
-# 🏆 Quickstart
+# 🏆 &nbsp; Overview
 
 This library includes a simplified interface for interacting with a v4 PoolTogether deployment. Create an instance of `PrizePoolNetwork` and use the initialized `PrizePool` and `PrizeDistributor` to begin reading and writing data to the protocol.
 
-There are several classes that provide interfaces to the different aspects of the V4 PoolTogether protocol.
+There are several classes that provide interfaces to the different aspects of the V4 PoolTogether protocol. `PrizePoolNetwork` is the main entry point.
 
 - [PrizePoolNetwork](./classes/PrizePoolNetwork.md)
+
 - [PrizePool](./classes/PrizePool.md)
 - [User](./classes/User.md)
 - [PrizeDistributor](./classes/PrizeDistributor.md)
 - [DrawCalculatorApi](./classes/DrawCalculatorApi.md)
 - [ContractFactory](./classes/ContractFactory.md)
 
-## 💾 Installation
+## 💾 &nbsp; Installation
 
 This project is available as an NPM package:
 
-```bash
+```sh
+npm install @pooltogether/v4-utils-js
+```
+
+or
+
+```sh
 yarn add @pooltogether/v4-client-js
 ```
 
-## 🌱 Initialization
+The repo can be cloned from Github for contributions.
+
+```sh
+git clone https://github.com/pooltogether/v4-client-js.git
+```
+
+## 🏎️ &nbsp; Quickstart
 
 ### PrizePoolNetwork
 
@@ -83,7 +102,7 @@ const signerPrizeDistributor = new PrizeDistributor(
 )
 ```
 
-## Examples
+## 🧮 &nbsp; Examples
 
 ### Get token data for a Prize Pool
 
@@ -171,7 +190,7 @@ NOTE: Ensure the `PrizeDistributor` was initialized with a `Signer`
 const txResponse: TransactionResponse = await prizeDistributor.claimPrizesByDraw(1)
 ```
 
-## 💻 Developer Experience
+## 💻 &nbsp; Developer Experience
 
 ### Contributing