Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,34 @@
# template-repos-ts-sol
# Discord Market

Template repository for using TypeScript and Solidity
Discord market contracts for the Dev Protocol ecosystem.

# Usage
## About

Create a repository using this template; just runs following command.
This repository contains the smart contracts that authenticate and tokenize Discord
activity for Dev Protocol. It was originally generated from the
[`template-repos-ts-sol`](https://github.com/dev-protocol/template-repos-ts-sol) template
and kept the template's name and description in `package.json` and `README.md` — this
commit aligns them with the repository's actual purpose.

The currently shipped contracts live in `contracts/`:

- `DiscordMarketV2.sol`
- `MarketAdmin.sol`
- `MarketProxy.sol`

## Installation

```bash
yarn
```

## Available Scripts

- `yarn generate` — compile the Solidity contracts
- `yarn test` — run the hardhat test suite
- `yarn build` — type-check the TypeScript sources
- `yarn lint` — run ESLint, Solhint, and Prettier

## License

[MPL-2.0](https://github.com/dev-protocol/discord-market/blob/main/LICENSE)
11 changes: 7 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
{
"name": "template-repos-ts-sol",
"name": "@devprotocol/discord-market",
"version": "1.0.0",
"description": "Template repository for using TypeScript and Solidity",
"description": "Discord market contracts for the Dev Protocol ecosystem",
"main": "index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/dev-protocol/discord-market.git"
},
"author": "Dev Protocol",
"scripts": {
"test": "hardhat test",
"pretest": "yarn generate",
Expand All @@ -16,8 +21,6 @@
"prebuild": "yarn generate",
"clean": "rimraf scripts/**/*.js build"
},
"author": "",
"license": "MPL-2.0",
"devDependencies": {
"@nomiclabs/hardhat-ethers": "2.1.1",
"@nomiclabs/hardhat-waffle": "2.0.5",
Expand Down