Browse Source

README updated

pull/2368/head
Aniket-Engg 3 months ago
committed by yann300
parent
commit
b3c643fa04
  1. 1
      gulpfile.js
  2. 1
      libs/README.md
  3. 21
      libs/remix-ws-templates/README.md
  4. 8
      libs/remix-ws-templates/package.json

1
gulpfile.js

@ -51,6 +51,7 @@ task('syncLibVersions', async function () {
'remix-solidity',
'remix-tests',
'remix-url-resolver',
'remix-ws-templates',
'remixd'
]

1
libs/README.md

@ -23,6 +23,7 @@ Here is the brief description of Remix libraries.
+ [`remix-lib`](remix-lib/README.md): Common place for libraries being used across multiple modules
+ [`remix-tests`](remix-tests/README.md): Unit test Solidity smart contracts. It works as a plugin & as CLI both
+ [`remix-url-resolver`](remix-url-resolver/README.md): Provide helpers for resolving the content from external URL ( including github, swarm, ipfs etc.).
+ [`remix-ws-templates`](remix-ws-templates/README.md): To create a workspace using different templates on Remix IDE
+ [`remixd`](remixd/README.md): Allow accessing local filesystem from Remix IDE by running a daemon
Each library is an NPM package and has basic documentation about its usage in its own `README`.

21
libs/remix-ws-templates/README.md

@ -1,7 +1,20 @@
# remix-ws-templates
## remix-ws-templates
[![npm version](https://badge.fury.io/js/%40remix-project%2Fremix-ws-templates.svg)](https://www.npmjs.com/package/@remix-project/remix-ws-templates)
This library was generated with [Nx](https://nx.dev).
## Running unit tests
`@remix-project/remix-ws-templates` is used to create a workspace using different templates on Remix IDE.
Run `nx test remix-ws-templates` to execute the unit tests via [Jest](https://jestjs.io).
### Installation
`@remix-project/remix-ws-templates` is an NPM package and can be installed using NPM as:
`npm install @remix-project/remix-ws-templates`
### Contribute
Please feel free to open an issue or a pull request.
In case you want to add some code, do have a look to our contribution guidelnes [here](https://github.com/ethereum/remix-project/blob/master/CONTRIBUTING.md). Reach us on [Gitter](https://gitter.im/ethereum/remix) in case of any queries.
### License
MIT © 2022 Remix Team

8
libs/remix-ws-templates/package.json

@ -1,7 +1,7 @@
{
"name": "@remix-project/remix-ws-templates",
"version": "1.0.0",
"description": "",
"description": "Create a Remix IDE workspace using different templates",
"main": "src/index.js",
"types": "src/index.d.ts",
"scripts": {
@ -15,5 +15,9 @@
"url": "git+https://github.com/ethereum/remix-project.git"
},
"author": "Aniket-Engg",
"license": "ISC"
"license": "MIT",
"bugs": {
"url": "https://github.com/ethereum/remix-project/issues"
},
"homepage": "https://github.com/ethereum/remix-project/tree/master/libs/remix-ws-templates#readme"
}
Loading…
Cancel
Save