Skip to content

Commit

Permalink
updates readme and gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
mpetrunic committed Aug 20, 2018
1 parent 1a3907c commit ef82e8f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ build/Release
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
node_modules/

dist/

# Users Environment Variables
.lock-wscript

Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Solidity comments generator
![build status](https://travis-ci.org/NodeFactoryIo/solidity-comments-core.svg?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/NodeFactoryIo/solidity-comments-core/badge.svg?branch=master)](https://coveralls.io/github/NodeFactoryIo/solidity-comments-core?branch=master)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-----------------------

Simple library that parses solidity contracts and inserts default solidity comments based on natspec.

## Development
Pull code, run `yarn install`, write tests :)
1 change: 0 additions & 1 deletion src/index.es6
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import { ContractFile } from './lib/contract/contract-file';
import { Contract } from './lib/contract/contract';
import CommentsGenerator from './lib/generators/comments-generator';
import ContractParts from './lib/contract-parts.es6';
import * as stringUtils from './lib/utils/string-utils';
import { pad } from './lib/utils/string-utils';

const generator = new CommentsGenerator();
Expand Down

0 comments on commit ef82e8f

Please sign in to comment.