remix lib readme updated

pull/713/head
aniket-engg 4 years ago committed by Aniket
parent 9b749992a0
commit 3150a5110b
  1. 2
      libs/remix-debug/README.md
  2. 78
      libs/remix-lib/README.md

@ -5,7 +5,7 @@
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/ethereum/remix-project/tree/master/libs/remix-debug)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/ethereum/remix-project/issues)
`@remix-project/remix-debug` is a tool to to debug Ethereum transactions on different Remix environments (VM, testnet etc.). It works underneath Remix IDE "DEBUGGER" plugin which is used to analyse step-to-step executioon of a transaction to debug it.
`@remix-project/remix-debug` is a tool to debug Ethereum transactions on different Remix environments (VM, testnet etc.). It works underneath Remix IDE "DEBUGGER" plugin which is used to analyse step-to-step executioon of a transaction to debug it.
### Installation
`@remix-project/remix-debug` is an NPM package and can be installed using NPM as:

@ -1,24 +1,54 @@
# `remix-lib`
Provides:
{
EventManager: EventManager,
helpers: {
trace: traceHelper,
ui: uiHelper
},
vm: {
Web3Providers: Web3Providers,
DummyProvider: DummyProvider,
Web3VMProvider: Web3VMProvider
},
SourceMappingDecoder: SourceMappingDecoder,
SourceLocationTracker: SourceLocationTracker,
init: init,
util: util,
AstWalker: AstWalker,
ui: {
styleGuide: styleGuide
}
}
## Remix Lib
[![npm version](https://badge.fury.io/js/%40remix-project%2Fremix-lib.svg)](https://www.npmjs.com/package/@remix-project/remix-lib)
[![npm](https://img.shields.io/npm/dt/@remix-project/remix-lib.svg?label=Total%20Downloads)](https://www.npmjs.com/package/@remix-project/remix-lib)
[![npm](https://img.shields.io/npm/dw/@remix-project/remix-lib.svg)](https://www.npmjs.com/package/@remix-project/remix-lib)
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/ethereum/remix-project/tree/master/libs/remix-lib)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/ethereum/remix-project/issues)
`@remix-project/remix-lib` is a common library to various remix tools. It is used in `remix-astwalker`, `remix-analyzer`, `remix-debug`, `remix-simulator`, `remix-solidity`, `remix-tests` libraries and in Remix IDE codebase.
### Installation
`@remix-project/remix-lib` is an NPM package and can be installed using NPM as:
`npm install @remix-project/remix-lib`
### How to use
`@remix-project/remix-lib` exports:
```
{
EventManager: EventManager,
helpers: {
ui: uiHelper,
compiler: compilerHelper
},
vm: {
Web3Providers: Web3Providers,
DummyProvider: DummyProvider,
Web3VMProvider: Web3VmProvider
},
Storage: Storage,
util: util,
execution: {
EventsDecoder: EventsDecoder,
txExecution: txExecution,
txHelper: txHelper,
executionContext: new ExecutionContext(),
txFormat: txFormat,
txListener: TxListener,
txRunner: TxRunner,
typeConversion: typeConversion
},
UniversalDApp: UniversalDApp
}
```
### 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 © 2018-21 Remix Team
Loading…
Cancel
Save