From 91a216e310333718c76cf7d786a46c1b43d5198f Mon Sep 17 00:00:00 2001 From: chenchongqiang Date: Tue, 18 Apr 2023 16:45:49 +0800 Subject: [PATCH] doc(packages): update package info --- .changeset/neat-tips-hammer.md | 10 +++++++ package.json | 3 --- packages/compiler-utils/README.md | 7 ++++- packages/compiler-utils/package.json | 21 ++++++++++++++- packages/core/README.md | 6 +++++ packages/core/package.json | 27 +++++++++++++++---- packages/docusaurus-plugin/README.md | 11 +++++--- packages/docusaurus-plugin/package.json | 35 +++++++++++++++---------- packages/provider/README.md | 6 +++++ packages/provider/package.json | 27 +++++++++++++++---- packages/solc/README.md | 11 ++++++-- packages/solc/package.json | 26 ++++++++++++++---- packages/tsconfig/README.md | 6 +++++ packages/tsconfig/package.json | 22 ++++++++++++++-- 14 files changed, 176 insertions(+), 42 deletions(-) create mode 100644 .changeset/neat-tips-hammer.md diff --git a/.changeset/neat-tips-hammer.md b/.changeset/neat-tips-hammer.md new file mode 100644 index 0000000..80e4468 --- /dev/null +++ b/.changeset/neat-tips-hammer.md @@ -0,0 +1,10 @@ +--- +"solive-docusaurus-theme-code": patch +"solive-compiler-utils": patch +"solive-provider": patch +"solive-tsconfig": patch +"solive-core": patch +"solive-solc": patch +--- + +update package info diff --git a/package.json b/package.json index a53d581..13ce578 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,6 @@ "pre-commit": "lint-staged --no-stash", "clean": "rimraf **/dist && rimraf node_modules **/node_modules" }, - "keywords": [], "devDependencies": { "@babel/core": "^7.19.1", "@babel/preset-env": "^7.19.1", @@ -67,8 +66,6 @@ "uuid": "^8.3.2", "webpack": "^5.77.0" }, - "author": "", - "license": "ISC", "husky": { "hooks": { "pre-commit": "lint-staged" diff --git a/packages/compiler-utils/README.md b/packages/compiler-utils/README.md index 78b0ddd..5a96a2e 100644 --- a/packages/compiler-utils/README.md +++ b/packages/compiler-utils/README.md @@ -1,4 +1,9 @@ ## Solive Compiler Utils - Solidity Compiler helper tool + +### Demo +- Check demo website: https://solive.wtf + +### DOC +- Check doc website: https://solive-doc.vercel.app diff --git a/packages/compiler-utils/package.json b/packages/compiler-utils/package.json index 7489df2..5f0ee36 100644 --- a/packages/compiler-utils/package.json +++ b/packages/compiler-utils/package.json @@ -16,5 +16,24 @@ "devDependencies": { "@types/semver": "^7.3.13", "solive-tsconfig": "workspace:*" - } + }, + "repository": { + "type": "git", + "url": "https://github.com/WTFAcademy/solive", + "directory": "packages/compiler-utils" + }, + "keywords": [ + "solidity", + "monaco-editor", + "solidity-editor", + "solive", + "compiler", + "compiler-utils" + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/WTFAcademy/solive/issues" + }, + "homepage": "https://github.com/WTFAcademy/solive", + "author": "WTFAcademy" } diff --git a/packages/core/README.md b/packages/core/README.md index 10c0409..a9c4d95 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,3 +1,9 @@ ## Solive Core Core package for solive + +### Demo +- Check demo website: https://solive.wtf + +### DOC +- Check doc website: https://solive-doc.vercel.app diff --git a/packages/core/package.json b/packages/core/package.json index a183666..296b495 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,7 +1,7 @@ { "name": "solive-core", "version": "0.0.1", - "description": "", + "description": "Solidity Monaco Editor Core Library", "main": "dist/index.js", "module": "dist/index.es.js", "files": [ @@ -13,9 +13,6 @@ "start:css": "tailwindcss -i src/index.css -o dist/index.css --watch", "build:css": "NODE_ENV=production tailwindcss -i src/index.css -o dist/index.css -m" }, - "keywords": [], - "author": "", - "license": "ISC", "peerDependencies": { "react": ">=17.0.2", "react-dom": ">=17.0.2" @@ -57,5 +54,25 @@ "solive-compiler-utils": "workspace:*", "solive-provider": "workspace:*", "solive-solc": "workspace:*" - } + }, + "repository": { + "type": "git", + "url": "https://github.com/WTFAcademy/solive", + "directory": "packages/core" + }, + "keywords": [ + "react", + "solidity", + "monaco-editor", + "solidity-editor", + "solive", + "solive-editor", + "solive-core" + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/WTFAcademy/solive/issues" + }, + "homepage": "https://github.com/WTFAcademy/solive", + "author": "WTFAcademy" } diff --git a/packages/docusaurus-plugin/README.md b/packages/docusaurus-plugin/README.md index eacb6b7..9d3635d 100644 --- a/packages/docusaurus-plugin/README.md +++ b/packages/docusaurus-plugin/README.md @@ -1,6 +1,9 @@ -Docusaurus Solive -================================= +## Docusaurus Solidity Plugin -A Docusaurus v2 plugin that supports referencing code examples from public GitHub repositories. +A Docusaurus v2 plugin that supports solidity code live. -> Note: this theme plugin requires [Docusaurus v2](https://v2.docusaurus.io/) +### Demo +- Check demo website: https://solive.wtf + +### DOC +- Check doc website: https://solive-doc.vercel.app diff --git a/packages/docusaurus-plugin/package.json b/packages/docusaurus-plugin/package.json index 5fa7783..2361379 100644 --- a/packages/docusaurus-plugin/package.json +++ b/packages/docusaurus-plugin/package.json @@ -19,19 +19,6 @@ "test": "jest", "start": "tsc --watch" }, - "repository": { - "type": "git", - "url": "" - }, - "keywords": [ - "docusarus" - ], - "author": "WTF", - "license": "MIT", - "bugs": { - "url": "" - }, - "homepage": "", "devDependencies": { "@types/node": "^17.0.38", "@types/react": "^18.0.0", @@ -51,5 +38,25 @@ "@docusaurus/types": "^2.3.1", "solive-core": "workspace:*", "uuid": "^8.3.2" - } + }, + "repository": { + "type": "git", + "url": "https://github.com/WTFAcademy/solive", + "directory": "packages/docusaurus-theme-code" + }, + "keywords": [ + "solidity", + "monaco-editor", + "solidity-editor", + "solive", + "docusaurus", + "docusaurus-plugin", + "docusaurus-theme" + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/WTFAcademy/solive/issues" + }, + "homepage": "https://github.com/WTFAcademy/solive", + "author": "WTFAcademy" } diff --git a/packages/provider/README.md b/packages/provider/README.md index 339ffd7..e5b9811 100644 --- a/packages/provider/README.md +++ b/packages/provider/README.md @@ -1,3 +1,9 @@ ## Solive Provider use Evm VM to run solidity code + +### Demo +- Check demo website: https://solive.wtf + +### DOC +- Check doc website: https://solive-doc.vercel.app diff --git a/packages/provider/package.json b/packages/provider/package.json index 738f343..9daf7da 100644 --- a/packages/provider/package.json +++ b/packages/provider/package.json @@ -1,7 +1,7 @@ { "name": "solive-provider", "version": "0.0.1", - "description": "", + "description": "Ethereum VM Provider", "module": "dist/index.js", "types": "dist/index.d.ts", "scripts": { @@ -11,9 +11,6 @@ "tsc": "tsc", "lint": "eslint 'src/**/*.{js,ts}'" }, - "keywords": [], - "author": "", - "license": "ISC", "devDependencies": { "lodash.merge": "^4.6.2", "npm-run-all": "^4.1.5", @@ -28,5 +25,25 @@ "js-sha3": "^0.8.0", "bn.js": "5.2.1", "hash.js": "1.1.7" - } + }, + "repository": { + "type": "git", + "url": "https://github.com/WTFAcademy/solive", + "directory": "packages/provider" + }, + "keywords": [ + "solidity", + "monaco-editor", + "solidity-editor", + "solive", + "vm-provider", + "evm", + "provider" + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/WTFAcademy/solive/issues" + }, + "homepage": "https://github.com/WTFAcademy/solive", + "author": "WTFAcademy" } diff --git a/packages/solc/README.md b/packages/solc/README.md index 339ffd7..bebd6d9 100644 --- a/packages/solc/README.md +++ b/packages/solc/README.md @@ -1,3 +1,10 @@ -## Solive Provider +## Solive Solc + +Solidity Contract Compiler Tool - Browser Supported + +### Demo +- Check demo website: https://solive.wtf + +### DOC +- Check doc website: https://solive-doc.vercel.app -use Evm VM to run solidity code diff --git a/packages/solc/package.json b/packages/solc/package.json index 63833ca..32013a1 100644 --- a/packages/solc/package.json +++ b/packages/solc/package.json @@ -1,7 +1,7 @@ { "name": "solive-solc", "version": "0.0.1", - "description": "", + "description": "Solidity Contract Compiler Tool - Browser Supported", "module": "dist/index.js", "types": "dist/index.d.ts", "scripts": { @@ -10,13 +10,29 @@ "tsc": "tsc", "lint": "eslint 'src/**/*.{js,ts}'" }, - "keywords": [], - "author": "", - "license": "ISC", "devDependencies": { "solive-tsconfig": "workspace:*" }, "dependencies": { "solc": "^0.8.19" - } + }, + "repository": { + "type": "git", + "url": "https://github.com/WTFAcademy/solive", + "directory": "packages/solc" + }, + "keywords": [ + "solidity", + "monaco-editor", + "solidity-editor", + "solive", + "solc", + "compiler" + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/WTFAcademy/solive/issues" + }, + "homepage": "https://github.com/WTFAcademy/solive", + "author": "WTFAcademy" } diff --git a/packages/tsconfig/README.md b/packages/tsconfig/README.md index 6169c07..d5ea973 100644 --- a/packages/tsconfig/README.md +++ b/packages/tsconfig/README.md @@ -1,3 +1,9 @@ ## Solive tsConfig tsConfig for solive + +### Demo +- Check demo website: https://solive.wtf + +### DOC +- Check doc website: https://solive-doc.vercel.app diff --git a/packages/tsconfig/package.json b/packages/tsconfig/package.json index 67d23e2..98cf5ae 100644 --- a/packages/tsconfig/package.json +++ b/packages/tsconfig/package.json @@ -1,7 +1,6 @@ { "name": "solive-tsconfig", "version": "0.0.1", - "license": "MIT", "scripts": { "build": "echo 'nothing to build'" }, @@ -15,5 +14,24 @@ }, "nx": { "ignore": true - } + }, + "repository": { + "type": "git", + "url": "https://github.com/WTFAcademy/solive", + "directory": "packages/tsconfig" + }, + "keywords": [ + "react", + "solidity", + "monaco-editor", + "solidity-editor", + "solive", + "tsconfig" + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/WTFAcademy/solive/issues" + }, + "homepage": "https://github.com/WTFAcademy/solive", + "author": "WTFAcademy" }