From e4c00cf0fc1f78673b06fd75d40fc4df832e1420 Mon Sep 17 00:00:00 2001 From: Jah-yee <166608075+Jah-yee@users.noreply.github.com> Date: Sat, 15 Aug 2026 21:20:23 +0800 Subject: [PATCH] docs: fix leftover template-repos-ts-sol name in package.json and README This repository was scaffolded from the `template-repos-ts-sol` template but the package metadata and README title were never updated to reflect the actual purpose (Dev Protocol treasury contracts). This commit: - Updates `package.json` `name` from `template-repos-ts-sol` to `@devprotocol/treasury` and rewrites the description. - Adds the missing `repository`, `author`, and removes duplicate `author`/`license` fields. - Rewrites the README so the title matches the repository name and adds a short description and the available scripts. --- README.md | 24 ++++++++++++++++++++---- package.json | 12 ++++++++---- 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b0541e91..95da1460 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ -# template-repos-ts-sol +# Treasury -Template repository for using TypeScript and Solidity +Treasury contracts for the Dev Protocol ecosystem. -# Usage +## About -Create a repository using this template; just runs following command. +This repository contains the Dev Protocol treasury smart contracts. 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. + +## 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/treasury/blob/main/LICENSE) diff --git a/package.json b/package.json index bb793423..448cd926 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,14 @@ { - "name": "template-repos-ts-sol", + "name": "@devprotocol/treasury", "version": "1.0.0", - "description": "Template repository for using TypeScript and Solidity", + "description": "Treasury contracts for the Dev Protocol ecosystem", "main": "index.js", + "repository": { + "type": "git", + "url": "git+https://github.com/dev-protocol/treasury.git" + }, + "author": "Dev Protocol", + "license": "MPL-2.0", "scripts": { "test": "hardhat test", "pretest": "yarn generate", @@ -17,8 +23,6 @@ "clean": "del 'artifacts'", "prepare": "husky install" }, - "author": "", - "license": "MPL-2.0", "devDependencies": { "@nomiclabs/hardhat-ethers": "2.1.1", "@nomiclabs/hardhat-waffle": "2.0.6",