Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(configs): adds readme for configs package #49

Merged
merged 2 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions configs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Aragon OSx Configs Commons

The `@aragon/osx-commons-configs` provides configurations and helpers for said
configurations necessary for the development of plugins and the OSx protocol.
This includes:

- Networks
- RPC url
- if it is a testnet or not
- chainID
mathewmeconry marked this conversation as resolved.
Show resolved Hide resolved
- alias for ethers and Alchemy subgraph
- Deployments of the OSx protocol grouped by network
- Version
- Contract name
- Contract address
- Deployment transaction
- Block number when the contract was deployed (This can differ from when the
mathewmeconry marked this conversation as resolved.
Show resolved Hide resolved
contract was activated and put in use)

## Installation

Use [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install
@aragon/osx-commons-configs.

```bash
npm install @aragon/osx-commons-configs
yarn add @aragon/osx-commons-configs
```

## Testing

To execute library tests just run:

```bash
yarn test
```

## Security

If you believe you've found a security issue, we encourage you to notify us. We
welcome working with you to resolve the issue promptly.

Security Contact Email: [email protected]

Please do not use the issue tracker for security issues.
6 changes: 3 additions & 3 deletions sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- Extendable JS client with built-in Web3, Subgraph and IPFS
- Extendable context for holding inheritable configuration

# Installation
## Installation

Use [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install
@aragon/osx-commons-sdk.
Expand All @@ -24,7 +24,7 @@ npm install @aragon/osx-commons-sdk
yarn add @aragon/osx-commons-sdk
```

# Usage
## Usage

The SDK usage is demonstrated in the
[SDK examples section of the Developer Portal](https://devs.aragon.org/docs/sdk/examples/).
Expand Down Expand Up @@ -64,7 +64,7 @@ When updating the `ClientCore` class:
- **Update first** all affected enum's, types and interfaces in
`src/internal/interfaces.ts`

# Testing
## Testing

To execute library tests just run:

Expand Down