Update README

README.md

@@ -1,22 +1,87 @@
 # Unstoppable Domains Profile Manager
 
-[![Push CI](https://github.com/unstoppabledomains/domain-profiles/actions/workflows/push.yml/badge.svg)](https://github.com/unstoppabledomains/domain-profiles/actions/workflows/push.yml)
+A set of common tools to manage your Unstoppable Domain 🛠️
+
+[![CI Status](https://github.com/unstoppabledomains/domain-profiles/actions/workflows/push.yml/badge.svg)](https://github.com/unstoppabledomains/domain-profiles/actions/workflows/push.yml)
 
 This repository contains the following:
 
-1. UD.me profile server, found in the `server` directory
-1. Reusable React components, found in the `packages` directory
+1. The UD.me profile server, found in the `server` directory
+1. Reusable React components, found in the `packages/ui-components` directory
+1. Unstoppable Domains configuration variables, found in the `packages/config` directory
+
+## Public Endpoints
+
+The UD.me profile service is hosted on both `testnet` (staging) and `mainnet` (production)
+environments. Example Unstoppable Domains profiles for each environment are provided below.
+
+- Staging: https://staging.ud.me/aaron.x
+- Production: https://ud.me/quirk.x
+
+## Usage
+
+The React components contained in the `domain-profiles` project can be used in your own
+project, and imported directly from NPM. Some of the components available are:
+
+- Unstoppable Messaging
+- Token Gallery
+- Wallet connect modal
+
+### Installation
+
+To use the Unstoppable Domains React components in your own project, install
+the package in your project directory:
+
+```shell
+// with npm
+npm install --save @unstoppabledomains/ui-components
+
+// with yarn
+yarn add @unstoppabledomains/ui-components
+```
+
+Note the `ui-components` package has peer dependencies on the React and the 
+React DOM. If you are not already using them in your project, you'll need to 
+install them (version > 18):
+
+```shell
+// with npm
+npm install react react-dom
+
+// with yarn
+yarn add react react-dom
+```
+
+### Developing
+
+To contribute changes to the `domain-profiles` project, you'll need to clone the
+project and build it in your local environment.
+
+```shell
+# Clone the project
+git clone [email protected]:unstoppabledomains/domain-profiles.git
+cd domain-profiles
+
+# Build the project locally
+yarn install # install dependencies
+yarn build # build shared packages
 
-## Endpoints
+# Run the development server
+yarn workspace server run dev
+```
 
-The UD.me profile service is hosted on both `testnet` (staging) and `mainnet`
-(production) environments. _The endpoints below are temporary, until the go-live
-date._
+### Testing
 
-### Staging
+To run the tests (`src/**/*.test.tsx` files):
 
-https://domain-profiles-vf5eblhuka-uc.a.run.app/aaron.x
+```shell
+yarn test          # run all tests
+yarn test:coverage # run all tests and generate coverage report
+```
 
-### Production
+### Linting and code formatting
 
-https://domain-profiles-wnjctwcyaa-uc.a.run.app/quirk.x
+```shell
+yarn lint   # automatically fixes linting errors
+yarn format # checks for formatting errors
+```

packages/ui-components/README.md

@@ -0,0 +1,87 @@
+# Unstoppable Domains Profile Manager
+
+A set of common tools to manage your Unstoppable Domain 🛠️
+
+[![CI Status](https://github.com/unstoppabledomains/domain-profiles/actions/workflows/push.yml/badge.svg)](https://github.com/unstoppabledomains/domain-profiles/actions/workflows/push.yml)
+
+This repository contains the following:
+
+1. The UD.me profile server, found in the `server` directory
+1. Reusable React components, found in the `packages/ui-components` directory
+1. Unstoppable Domains configuration variables, found in the `packages/config` directory
+
+## Public Endpoints
+
+The UD.me profile service is hosted on both `testnet` (staging) and `mainnet` (production)
+environments. Example Unstoppable Domains profiles for each environment are provided below.
+
+- Staging: https://staging.ud.me/aaron.x
+- Production: https://ud.me/quirk.x
+
+## Usage
+
+The React components contained in the `domain-profiles` project can be used in your own
+project, and imported directly from NPM. Some of the components available are:
+
+- Unstoppable Messaging
+- Token Gallery
+- Wallet connect modal
+
+### Installation
+
+To use the Unstoppable Domains React components in your own project, install
+the package in your project directory:
+
+```shell
+// with npm
+npm install --save @unstoppabledomains/ui-components
+
+// with yarn
+yarn add @unstoppabledomains/ui-components
+```
+
+Note the `ui-components` package has peer dependencies on the React and the 
+React DOM. If you are not already using them in your project, you'll need to 
+install them (version > 18):
+
+```shell
+// with npm
+npm install react react-dom
+
+// with yarn
+yarn add react react-dom
+```
+
+### Developing
+
+To contribute changes to the `domain-profiles` project, you'll need to clone the
+project and build it in your local environment.
+
+```shell
+# Clone the project
+git clone [email protected]:unstoppabledomains/domain-profiles.git
+cd domain-profiles
+
+# Build the project locally
+yarn install # install dependencies
+yarn build # build shared packages
+
+# Run the development server
+yarn workspace server run dev
+```
+
+### Testing
+
+To run the tests (`src/**/*.test.tsx` files):
+
+```shell
+yarn test          # run all tests
+yarn test:coverage # run all tests and generate coverage report
+```
+
+### Linting and code formatting
+
+```shell
+yarn lint   # automatically fixes linting errors
+yarn format # checks for formatting errors
+```