Skip to content
This repository has been archived by the owner on May 8, 2023. It is now read-only.

Commit

Permalink
Tiny readme adjustments for 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
chmanie committed Dec 19, 2022
1 parent 8b39bd5 commit 4681b28
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@

# Colony SDK

The Colony SDK is under heavy development by the community and will be an easy-to-use interface for the Colony Network contracts, providing simple functions that hide the dark magic going on under the hood of ColonyJS. It should cover the most common use cases and is constantly updated with new features.
The Colony SDK is under heavy development by the community and will be an easy-to-use interface for the Colony Network contracts, providing simple functions that hide the dark magic going on under the hood of ColonyJS.
It covers _everything_ the dApp can do, so you'll be able to run your DAO entirely programmatically 👩‍💻

Colony SDK also includes a variety of examples to get you up and building with Colony in no time!

Expand All @@ -28,7 +29,7 @@ const start = async () => {
// This will try to connect the page to MetaMask
await provider.send('eth_requestAccounts', []);
// Create a new connection to the Colony Network contracts using the MetaMask "wallet"
const colonyNetwork = new ColonyNetwork(provider.getSigner());
const colonyNetwork = await ColonyNetwork.init(provider.getSigner());
// Connect to the MetaColony (this could be replaced with your own colony using `colonyNetwork.getColony(COLONY_ADDRESS)`)
const metaColony = await colonyNetwork.getMetaColony();
// Get the CLNY funding for the MetaColony (CLNY is it's native token)
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ sidebar_position: 0
The Colony SDK is a community project aiming to provide a quick and easy way to get started with building on top of Colony Network contracts.

The goal is to simplify the complexity of the contract's functions to serve the most popular functions using an easy-to-understand programming interface while providing sane defaults and fallbacks. We also provide various examples for various applications to get you up and building with Colony in no time!
Since version 1.0 it covers _everything_ the dApp can do, so you'll be able to run your DAO entirely programmatically 👩‍💻

If you're impatient to start building, check out the [Getting Started](getting-started/index.md) pages.

Expand Down

0 comments on commit 4681b28

Please sign in to comment.