Update readme
This commit is contained in:
parent
b072c7ef89
commit
8f3f7803e3
15
README.md
15
README.md
|
@ -1,11 +1,22 @@
|
|||
# Solidity flat file generation
|
||||
# Solidity smart-contract flattened source file generation
|
||||
|
||||
[![Build Status](https://travis-ci.org/poanetwork/solidity-flattener.svg?branch=master)](https://travis-ci.org/poanetwork/solidity-flattener)
|
||||
[![Known Vulnerabilities](https://snyk.io/test/github/poanetwork/solidity-flattener/badge.svg)](https://snyk.io/test/github/poanetwork/solidity-flattener)
|
||||
[![Coverage Status](https://coveralls.io/repos/github/poanetwork/solidity-flattener/badge.svg?branch=master)](https://coveralls.io/github/poanetwork/solidity-flattener?branch=master)
|
||||
|
||||
##### Combines all local imports to one .sol file
|
||||
## Utility to combine all imports to one flatten .sol file
|
||||
|
||||
### Installation from npm
|
||||
|
||||
`npm i @poanet/solidity-flattener`
|
||||
|
||||
### Usage
|
||||
|
||||
`./node_modules/.bin/poa-solidity-flattener ./contracts/example.sol`
|
||||
|
||||
It will save flattened source of Solidity smart-contract into `./out` directory
|
||||
|
||||
### Installation from source
|
||||
|
||||
|
||||
```
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@poanet/solidity-flattener",
|
||||
"version": "3.0.1",
|
||||
"version": "3.0.2",
|
||||
"lockfileVersion": 1,
|
||||
"requires": true,
|
||||
"dependencies": {
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@poanet/solidity-flattener",
|
||||
"version": "3.0.1",
|
||||
"version": "3.0.2",
|
||||
"description": "Combine solidity files to one flat file",
|
||||
"scripts": {
|
||||
"start": "node index.js",
|
||||
|
|
Loading…
Reference in New Issue