@unstoppabledomains/config - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

CHANGELOG.md

		@@ -0,3 +1,12 @@
		# Change Log

		All notable changes to this project will be documented in this file. This
		project adheres to [Semantic Versioning](http://semver.org/).

		## 0.0.2

		- Update the README to include usage examples

		## 0.0.1

		- Initial version

package.json

		{
		"name": "@unstoppabledomains/config",
		"version": "0.0.1",
		"version": "0.0.2",
		"private": false,
		@@ -5,0 +5,0 @@ "description": "Configuration variables for Unstoppable Domains environments",

README.md

		@@ -1,59 +0,29 @@
		# Unstoppable Domains Profile Manager
		# Unstoppable Domains Config

		A set of common tools to manage your Unstoppable Domain 🛠️
		A common configuration reference for Unstoppable Domains environments 🛠️

		[![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:
		To use the Unstoppable Domains config in your own project, install the
		module in your project directory:

		```shell
		// with npm
		npm install --save @unstoppabledomains/ui-components
		npm install --save @unstoppabledomains/config

		// with yarn
		yarn add @unstoppabledomains/ui-components
		yarn add @unstoppabledomains/config
		```

		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):
		## Usage

		```shell
		// with npm
		npm install react react-dom
		```typescript
		import config from '@unstoppabledomains/config';

		// with yarn
		yarn add react react-dom
		console.log("Unstoppable Domains smart contract", config.UNSTOPPABLE_CONTRACT_ADDRESS);
		```

		### Developing
		## Contributing

		@@ -81,4 +51,4 @@ To contribute changes to the `domain-profiles` project, you'll need to clone the
		```shell
		yarn test # run all tests
		yarn test:coverage # run all tests and generate coverage report
		yarn test # run all tests
		yarn test:ci # run all tests and generate coverage report
		```
		@@ -85,0 +55,0 @@

@unstoppabledomains/config - npm Package Compare versions

New alerts

Fixed alerts

Worsened metrics