From efd9465c96eb1f8fb7050555d62019bf195792ca Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Tue, 29 Dec 2020 16:49:05 +0530 Subject: [PATCH] astwalker readme --- libs/remix-analyzer/README.md | 1 - libs/remix-astwalker/README.md | 30 ++++++++++++++++++++++++++---- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/libs/remix-analyzer/README.md b/libs/remix-analyzer/README.md index f592551c94..89637d8630 100644 --- a/libs/remix-analyzer/README.md +++ b/libs/remix-analyzer/README.md @@ -56,6 +56,5 @@ 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 diff --git a/libs/remix-astwalker/README.md b/libs/remix-astwalker/README.md index a3c674ac67..cc6416b8b0 100644 --- a/libs/remix-astwalker/README.md +++ b/libs/remix-astwalker/README.md @@ -1,7 +1,21 @@ -## Remix ASTwalker -`remix-astwalker` module walks through solidity AST and spits out AST nodes. +## Remix Astwalker +[![npm version](https://badge.fury.io/js/%40remix-project%2Fremix-astwalker.svg)](https://www.npmjs.com/package/@remix-project/remix-astwalker) +[![npm](https://img.shields.io/npm/dt/@remix-project/remix-astwalker.svg?label=Total%20Downloads)](https://www.npmjs.com/package/@remix-project/remix-astwalker) +[![npm](https://img.shields.io/npm/dw/@remix-project/remix-astwalker.svg)](https://www.npmjs.com/package/@remix-project/remix-astwalker) +[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/ethereum/remix-project/tree/master/libs/remix-astwalker) +[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/ethereum/remix-project/issues) + +`@remix-project/remix-astwalker` is a tool to parse AST (Abstract Syntax Tree) generated by Solidity compiler to perform certain operations. It is used in `remix-analyzer`, `remix-debug` and in `contextualListener` plugin of Remix IDE. + +### Installation +`@remix-project/remix-astwalker` is an NPM package and can be installed using NPM as: + +`npm install @remix-project/remix-astwalker` + +### How to use + +`@remix-project/remix-astwalker` can be used as: -#### Example ```ts import { AstWalker } from "remix-astwalker"; @@ -16,4 +30,12 @@ astWalker.on("node", node => { } }); ``` -For more examples see `tests`. + +### 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