Skip to content

Commit

Permalink
shields.io docs.rs badges (#740)
Browse files Browse the repository at this point in the history
* docs.rs shield.io badges

missing docs.rs:
cw-fund-distributor
cw-tokenfactory-issuer
cw721-roles
dao-voting-cw721-roles
dao-voting-token-factory-staked

* Readme h1 touchups

* Removed extra linebreaks

* Main README.md shields

Added shields for:
* github latest release
* Discord
* x/Twitter

* Change contract docs.rs shield to latest release instead of v2.2.0

* Add docs.rs logo to contract shields

* Add crates.io to contract shields

* Add commit activity and contributor count to main README.md shields

* Added logos to commit activity and contributor main README.md shields

Rearranged shields

* Added DAO DAO DAO to main README.md shields
  • Loading branch information
poroburu authored Sep 2, 2023
1 parent 3712508 commit bf3ef9c
Show file tree
Hide file tree
Showing 21 changed files with 73 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# DAO Contracts

[![GitHub tag (with filter)](https://img.shields.io/github/v/tag/DA0-DA0/dao-contracts?label=Latest%20version&logo=github)](https://github.com/DA0-DA0/dao-contracts/releases/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/DA0-DA0/dao-contracts?logo=github)](https://github.com/DA0-DA0/dao-contracts/graphs/contributors)

[![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/DA0-DA0/dao-contracts?logo=git)](https://github.com/DA0-DA0/dao-contracts/pulse/monthly)
[![codecov](https://codecov.io/gh/DA0-DA0/dao-contracts/branch/main/graph/badge.svg?token=SCKOIPYZPV)](https://codecov.io/gh/DA0-DA0/dao-contracts)

[![Discord](https://img.shields.io/discord/895922260047720449?logo=discord&label=Discord)](https://discord.gg/MUBxdbwJDD)
[![X (formerly Twitter) URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FDA0_DA0&label=DA0_DA0)](https://twitter.com/DA0_DA0)

[![DAO DAO DAO](https://img.shields.io/badge/DAO%20DAO%20DAO-gray?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAAR1QTFRF%2F%2F%2F%2F7%2FDw0NDRoaOjgoSFY2VmREdIJSgpFhgaBgkLNTc4sbKz0dHRREZINTc54ODgwMHCwMLCJSgpREZIoqOjNTc5VFZXoqOksbKz0dHRwcHCkpOUsbKyoqKjJikqc3V2g4SFoaGiwMDB7%2FDwoaKjFxkb39%2FfkZKTFhgaY2VnZGZnZGVn7u%2FvgoOEdHZ3BwoM%2Fv7%2BwcLCRUhJNjg5NTc4gYOENTg5cnR2c3V3sLGy7%2B%2Fv0NHR0NDRU1ZXoaOkgoSFY2VmREdIz9DQJSgqoaKiFhkaBgkL3%2BDgv8DBNDc5z8%2FQsLKzVVdY7u7uwMHBkpSUFxobZWZodHV3sbGyc3R2Njg6RUdJoKKiv8HBr7GykZOT3t%2Ff%2F%2F%2F%2FcnR1oaOjFOTQHAAAAA90Uk5T%2Fv7%2B%2Fv7%2B%2Fv7%2B%2Fv7%2B%2Fv7%2B6a2FXwAABrRJREFUaN7Vm%2BtjmzYQwNnWx7ZuUwq1jU0Dbp04LM0CTWu3pWnBdXHjuY9kXV8b5P%2F%2FM4aFAElIIAH5sPsWk%2BjnO%2B4hnS5KJCPe6Us%2FWCyX4SqRcLleBP7mVGoFRRGHvYzXK6asg0vQNXDH58ByaHy7O6DnhysBUWPQCXBHWwnLYtMaeKdHrLjsxwN9CDyoOBiNjFhTSTUvWwHv4qv1Yt1jWlyPe8LISiBuTM3wqtYBu9jvmqAR0LOKLz326t0B3CvMEQB54E7%2B59pINMh0rdauPGChnjhuK%2FdzpDWRAQK1EQ4i1co3yQbuoUAPjaiBZO9yXxcF%2Bpl6IGok0wAt4IsBrTbqpXJg84gM4O%2FIz0DUQqbIrIf1QMR74EWt5KjPJpaAiDeOWssfTCIN9Dvj5cTjKiDiGVHUIdHnA%2B92qB90Vrics8cDgrBbXqbjPmADPbVrXkY0J0xgGvD9LnmR%2B4ByHAx4J413r1NgdATN5jwsA9MCEYKoY5nahFELYNBlQJRd9ZgGgnRr0D0vcjXcqDlQbZ%2Bwq416QgJTj9mLrkSgUR2dAKYKXg0PGdXEgamCD68IGN2HKl5iQKjg4qp4SMVHBVC%2FWgUzFR%2FmQI2toLeJ%2B9vDbrhexBuvvYonGTCNQb10siBPhf1NaxUnCGgxXPSuyjhxXjZXUUWlGALVUgwCziH0cePMMIOFMQXuwLXwpQzuEdtummyPkNtsgRbtMn7Vqdpv4zY%2BBM4pi%2FrV53i%2FRX57tAUCyqJ%2BXefAb2HTSQKEae1x8f7qexWN3qM7h%2BktAcLK%2B4TauVWK3cRXXegqTxPgnIj6nlA7pomKz%2BBLTIBwiQmxk6oVvfFL%2FE55TqQZVQzYpHK6yy3we0XHbaSL9rgaVBb3xRb4g%2BLjPvNCuKnW1GuuKQHm6BPhLp49kSfubf%2FwuqJhFipbNByPomgYCLmN5ydrrS%2Br3fSGMseAVsk5ANW3yeUJ91jP7bS92j69qSyxxFYqSvnfApt60mdXPOqsRH6jFGhjYTinVg34Gb0UGK9rky0MxB8V%2BCvoI1oNrGE%2For2GlSqRnHDcdPvsJwJIWxT%2F9apn2WpInP8PEMsnz%2BlnE1ZFT%2BURRZoQQNxpbH6pDbgOjO%2BSyl0L6OKE0%2BBhseQWPlAb%2BUdFWNC2fEOExRJzx3kp8KcuEdRVZZ8f%2BGj1s%2B3Tn9PUpnPsloTin657NmNsAxjdjntJ9dYY%2FfgBBryRJu9LTmrrJn0b2L7tOlGeBhJA8ZKo60R5GmD2eS4DPBEuvKdF4Di3yC2GLQF0TgV7CvtYdk%2B2GBM8jDUZFd%2BKKRic4JsoapvoywAdobd45hjUNtHCvGYkA%2BQWPlzeqcj0qc8cJsABvtW3pYjHIjsnE9%2Fq7yVA4iVaUsD6c80s77LDxOaA%2FLhmNLFpLXFWOPPr%2FLiWekq20dS6JM6KWpWWr6cQOMJtakgCedd2W3%2BxsFo1xY7caVVCX3ViyxJNTgI4U%2FFa9Rr9AIE%2Bnmz8lbSwLmBfaUQxTjeRTxEw9dP3TVUsN428M40qxs9SH2W2voxVEwn7H26fJqXQe7P50A%2Fp3QbV%2BkJu876ho1a93wirvbBFi9qXc1zFUWc8B5Q6tAi4S6hodQUcEwru4S1oE1dxYnZrUFcttaDRyfAg2xTud8E7B3gMIv%2FJrxGgle0p%2Bmm3ixdoEPtHk7q3GJFH93F3L9ANcP8proIswqjRRVveX%2BRV0GHp7in1lNyobYkX%2BR4qJLbj2HVealT1qBPiRbHFIM83VReWxx3w3D5pXwKIwm%2BWfzB2WvpLdogzPc6l8z5FNBrF4%2FkuxTsHvGt1FH4FETTIOdhxLeU5H%2FmDA2OaKG%2FWvz36UDyuGo04LhGBKYPEJ4xYvPLwBwqGmYsZWhhJjODMKIflADNi%2FyiSRYb44fddn8ljDfBcZMd7wp0%2B1SHJSbvswE%2FzmCNKyHPsAxf%2FdHhoOlxoGJPTYQchlVArgblnBlPy86Hx%2BbwMDbUxNYs21VbcsRX2mJmOAl794tKPhrr%2F9nM2stsL4sGwfOkTlhJAHbAIePWrK9loLrakEoN0SV49zky3kELmODwBiAC3oZB38L%2B50jiTN2JYMe4JDnP%2FUL9M65mer65q1ItqBlrxrLZImBVQ74PGzm9SQCrFrONv71wG1dsQA%2BDmx6oVa4eSqaymLuJ%2Fvn79Nx1KfnO6eRn3yZ7numaARGDsWv%2FsNCoWjYHJu7SEkvdSZJJYdHR%2BZH1yKqG9sdisrcQ%2FB4DdwwTKovbigfCkhiIpv9y6dv3X37JcutQCfzCUGgtR%2FgO61zuwRnnviwAAAABJRU5ErkJggg%3D%3D)](https://daodao.zone/dao/juno10h0hc64jv006rr8qy0zhlu4jsxct8qwa0vtaleayh0ujz0zynf2s2r7v8q)


This is a collection of smart contracts for building composable, modular, and upgradable DAOs.

For a detailed look at how these contracts work, see [our wiki](https://github.com/DA0-DA0/dao-contracts/wiki/DAO-DAO-Contracts-Design).
Expand Down
3 changes: 3 additions & 0 deletions contracts/dao-dao-core/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# dao-dao-core

[![dao-dao-core on crates.io](https://img.shields.io/crates/v/dao-dao-core.svg?logo=rust)](https://crates.io/crates/dao-dao-core)
[![docs.rs](https://img.shields.io/docsrs/dao-dao-core?logo=docsdotrs)](https://docs.rs/dao-dao-core/latest/dao_dao_core/index.html)

This contract is the core module for all DAO DAO DAOs. It handles
management of voting power and proposal modules, executes messages,
and holds the DAO's treasury.
Expand Down
3 changes: 3 additions & 0 deletions contracts/external/cw-admin-factory/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# cw-admin-factory

[![cw-admin-factory on crates.io](https://img.shields.io/crates/v/cw-admin-factory.svg?logo=rust)](https://crates.io/crates/cw-admin-factory)
[![docs.rs](https://img.shields.io/docsrs/cw-admin-factory?logo=docsdotrs)](https://docs.rs/cw-admin-factory/latest/cw_admin_factory/)

Serves as a factory that instantiates contracts and sets them as their
own wasm admins.

Expand Down
3 changes: 3 additions & 0 deletions contracts/external/cw-payroll-factory/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# cw-payroll-factory

[![cw-payroll-factory on crates.io](https://img.shields.io/crates/v/cw-payroll-factory.svg?logo=rust)](https://crates.io/crates/cw-payroll-factory)
[![docs.rs](https://img.shields.io/docsrs/cw-payroll-factory?logo=docsdotrs)](https://docs.rs/cw-payroll-factory/latest/cw_payroll_factory/)

Serves as a factory that instantiates [cw-vesting](../cw-vesting) contracts and stores them in an indexed maps for easy querying by recipient or the instantiator (i.e. give me all of my vesting payment contracts or give me all of a DAO's vesting payment contracts).

An optional `owner` can be specified when instantiating `cw-payroll-factory` that limits contract instantiation to a single account.
3 changes: 3 additions & 0 deletions contracts/external/cw-token-swap/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# cw-token-swap

[![cw-token-swap on crates.io](https://img.shields.io/crates/v/cw-token-swap.svg?logo=rust)](https://crates.io/crates/cw-token-swap)
[![docs.rs](https://img.shields.io/docsrs/cw-token-swap?logo=docsdotrs)](https://docs.rs/cw-token-swap/latest/cw_token_swap/)

This is an escrow token swap contract for swapping between native and
cw20 tokens. The contract is instantiated with two counterparties and
their promised funds. Promised funds may either be native tokens or
Expand Down
3 changes: 3 additions & 0 deletions contracts/external/cw-vesting/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# cw-vesting

[![cw-vesting on crates.io](https://img.shields.io/crates/v/cw-vesting.svg?logo=rust)](https://crates.io/crates/cw-vesting)
[![docs.rs](https://img.shields.io/docsrs/cw-vesting?logo=docsdotrs)](https://docs.rs/cw-vesting/latest/cw_vesting/)

This contract enables the creation of native && cw20 token streams, which allows a payment to be vested continuously over time.

Key features include:
Expand Down
3 changes: 3 additions & 0 deletions contracts/external/dao-migrator/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# dao-migrator

[![dao-migrator on crates.io](https://img.shields.io/crates/v/dao-migrator.svg?logo=rust)](https://crates.io/crates/dao-migrator)
[![docs.rs](https://img.shields.io/docsrs/dao-migrator?logo=docsdotrs)](https://docs.rs/dao-migrator/latest/dao_migrator/)

Here is the [discussion](https://github.com/DA0-DA0/dao-contracts/discussions/607).

A migrator module for a DAO DAO DAO which handles migration for DAO modules
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Single choice proposal approval contract

[![dao-pre-propose-approval-single on crates.io](https://img.shields.io/crates/v/dao-pre-propose-approval-single.svg?logo=rust)](https://crates.io/crates/dao-pre-propose-approval-single)
[![docs.rs](https://img.shields.io/docsrs/dao-pre-propose-approval-single?logo=docsdotrs)](https://docs.rs/dao-pre-propose-approval-single/latest/dao_pre_propose_approval_single/)

This contract implements an approval flow for proposals, it also handles deposit logic. It works with the `cwd-proposal-single` proposal module.

## Approval Logic
Expand Down
3 changes: 3 additions & 0 deletions contracts/pre-propose/dao-pre-propose-approver/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Proposal Approver Contract

[![dao-pre-propose-approver on crates.io](https://img.shields.io/crates/v/dao-pre-propose-approver.svg?logo=rust)](https://crates.io/crates/dao-pre-propose-approver)
[![docs.rs](https://img.shields.io/docsrs/dao-pre-propose-approver?logo=docsdotrs)](https://docs.rs/dao-pre-propose-approver/latest/dao_pre_propose_approver/)

This contract works in conjuction with `cwd-pre-propose-approval-single` and allows for automatically creating approval proposals when a proposal is submitted for approval.

## Approver Logic
Expand Down
3 changes: 3 additions & 0 deletions contracts/pre-propose/dao-pre-propose-multiple/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Multiple choice proposal deposit contract

[![dao-pre-propose-multiple on crates.io](https://img.shields.io/crates/v/dao-pre-propose-multiple.svg?logo=rust)](https://crates.io/crates/dao-pre-propose-multiple)
[![docs.rs](https://img.shields.io/docsrs/dao-pre-propose-multiple?logo=docsdotrs)](https://docs.rs/dao-pre-propose-multiple/latest/dao_pre_propose_multiple/)

This is a pre-propose module that manages proposal deposits for the
`dao-proposal-multiple` proposal module.

Expand Down
3 changes: 3 additions & 0 deletions contracts/pre-propose/dao-pre-propose-single/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Single choice proposal deposit contract

[![dao-pre-propose-single on crates.io](https://img.shields.io/crates/v/dao-pre-propose-single.svg?logo=rust)](https://crates.io/crates/dao-pre-propose-single)
[![docs.rs](https://img.shields.io/docsrs/dao-pre-propose-single?logo=docsdotrs)](https://docs.rs/dao-pre-propose-single/latest/dao_pre_propose_single/)

This is a pre-propose module that manages proposal deposits for the
`cwd-proposal-single` proposal module.

Expand Down
5 changes: 5 additions & 0 deletions contracts/proposal/dao-proposal-condorcet/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# dao-proposal-condorcet

[![dao-proposal-condorcet on crates.io](https://img.shields.io/crates/v/dao-proposal-condorcet.svg?logo=rust)](https://crates.io/crates/dao-proposal-condorcet)
[![docs.rs](https://img.shields.io/docsrs/dao-proposal-condorcet?logo=docsdotrs)](https://docs.rs/dao-proposal-condorcet/latest/dao_proposal_condorcet/)

This is a DAO DAO proposal module which implements The Condorcet
Method.

Expand Down
5 changes: 4 additions & 1 deletion contracts/proposal/dao-proposal-multiple/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
## dao-proposal-multiple
# dao-proposal-multiple

[![dao-proposal-multiple on crates.io](https://img.shields.io/crates/v/dao-proposal-multiple.svg?logo=rust)](https://crates.io/crates/dao-proposal-multiple)
[![docs.rs](https://img.shields.io/docsrs/dao-proposal-multiple?logo=docsdotrs)](https://docs.rs/dao-proposal-multiple/latest/dao_proposal_multiple/)

A proposal module for a DAO DAO DAO which allows the users to select
their voting choice(s) from an array of `MultipleChoiceOption`.
Expand Down
3 changes: 3 additions & 0 deletions contracts/proposal/dao-proposal-single/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# dao-proposal-single

[![dao-proposal-single on crates.io](https://img.shields.io/crates/v/dao-proposal-single.svg?logo=rust)](https://crates.io/crates/dao-proposal-single)
[![docs.rs](https://img.shields.io/docsrs/dao-proposal-single?logo=docsdotrs)](https://docs.rs/dao-proposal-single/latest/dao_proposal_single/)

A proposal module for a DAO DAO DAO which supports simple "yes", "no",
"abstain" voting. Proposals may have associated messages which will be
executed by the core module upon the proposal being passed and
Expand Down
3 changes: 3 additions & 0 deletions contracts/staking/cw20-stake-external-rewards/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# CW20 Stake External Rewards

[![cw20-stake-external-rewards on crates.io](https://img.shields.io/crates/v/cw20-stake-external-rewards.svg?logo=rust)](https://crates.io/crates/cw20-stake-external-rewards)
[![docs.rs](https://img.shields.io/docsrs/cw20-stake-external-rewards?logo=docsdotrs)](https://docs.rs/cw20-stake-external-rewards/latest/cw20_stake_external_rewards/)

This contract enables staking rewards in terms of non-governance
tokens.
3 changes: 3 additions & 0 deletions contracts/staking/cw20-stake-reward-distributor/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# CW20 Stake Reward Distributor

[![cw20-stake-reward-distributor on crates.io](https://img.shields.io/crates/v/cw20-stake-reward-distributor.svg?logo=rust)](https://crates.io/crates/cw20-stake-reward-distributor)
[![docs.rs](https://img.shields.io/docsrs/cw20-stake-reward-distributor?logo=docsdotrs)](https://docs.rs/cw20-stake-reward-distributor/latest/cw20_stake_reward_distributor/)

A contract to fund cw20-stake contracts with rewards in terms of the
same tokens being staked.

3 changes: 3 additions & 0 deletions contracts/staking/cw20-stake/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# CW20 Stake

[![cw20-stake on crates.io](https://img.shields.io/crates/v/cw20-stake.svg?logo=rust)](https://crates.io/crates/cw20-stake)
[![docs.rs](https://img.shields.io/docsrs/cw20-stake?logo=docsdotrs)](https://docs.rs/cw20-stake/latest/cw20_stake/)

This is a basic implementation of a cw20 staking contract. Staked
tokens can be unbonded with a configurable unbonding period. Staked
balances can be queried at any arbitrary height by external contracts.
3 changes: 3 additions & 0 deletions contracts/voting/dao-voting-cw20-staked/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# CW20 Staked Balance Voting

[![dao-voting-cw20-staked on crates.io](https://img.shields.io/crates/v/dao-voting-cw20-staked.svg?logo=rust)](https://crates.io/crates/dao-voting-cw20-staked)
[![docs.rs](https://img.shields.io/docsrs/dao-voting-cw20-staked?logo=docsdotrs)](https://docs.rs/dao-voting-cw20-staked/latest/dao_voting_cw20_staked/)

A voting power module which determines voting power based on the
staked token balance of specific addresses at given heights.

Expand Down
3 changes: 3 additions & 0 deletions contracts/voting/dao-voting-cw4/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# CW4 Group Voting

[![dao-voting-cw4 on crates.io](https://img.shields.io/crates/v/dao-voting-cw4.svg?logo=rust)](https://crates.io/crates/dao-voting-cw4)
[![docs.rs](https://img.shields.io/docsrs/dao-voting-cw4?logo=docsdotrs)](https://docs.rs/dao-voting-cw4/latest/dao_voting_cw4/)

A simple voting power module which determines voting power based on
the weight of a user in a cw4-group contract. This allocates voting
power in the same way that one would expect a multisig to.
Expand Down
3 changes: 3 additions & 0 deletions contracts/voting/dao-voting-cw721-staked/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# `dao-voting-cw721-staked`

[![dao-voting-cw721-staked on crates.io](https://img.shields.io/crates/v/dao-voting-cw721-staked.svg?logo=rust)](https://crates.io/crates/dao-voting-cw721-staked)
[![docs.rs](https://img.shields.io/docsrs/dao-voting-cw721-staked?logo=docsdotrs)](https://docs.rs/dao-voting-cw721-staked/latest/dao_voting_cw721_staked/)

This is a basic implementation of an NFT staking contract.

Staked tokens can be unbonded with a configurable unbonding period. Staked balances can be queried at any arbitrary height by external contracts. This contract implements the interface needed to be a DAO DAO [voting module](https://github.com/DA0-DA0/dao-contracts/wiki/DAO-DAO-Contracts-Design#the-voting-module).
Expand Down
3 changes: 3 additions & 0 deletions contracts/voting/dao-voting-native-staked/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# CW Native Staked Balance Voting

[![dao-voting-native-staked on crates.io](https://img.shields.io/crates/v/dao-voting-native-staked.svg?logo=rust)](https://crates.io/crates/dao-voting-native-staked)
[![docs.rs](https://img.shields.io/docsrs/dao-voting-native-staked?logo=docsdotrs)](https://docs.rs/dao-voting-native-staked/latest/dao_voting_native_staked/)

Simple native token voting contract which assumes the native denom
provided is not used for staking for securing the network e.g. IBC
denoms or secondary tokens (ION). Staked balances may be queried at an
Expand Down

0 comments on commit bf3ef9c

Please sign in to comment.