Improve documentation dependencies

[iGitScor]

Write some documentation improvements with project dependencies (e.g.: shields)

[dhruvdutt]

Can I do it?

[iGitScor]

Of course, please feel free to make a pull request with your enhancement :wink:

[dhruvdutt]

What is / are shields? I'm assuming you need documentation for every js function. Probably follow standard jsdoc conventions.

[iGitScor]

Shields are badges about dependencies (e.g. npm version, etc...)

This issue is about the project structure documentation, but your idea is very interesting to make a documentation about the code itself (with maybe a documentation generation tool). As you want, you can choose what improvement you want to make @dhruvdutt

[iGitScor]

Still need contributions

[dhruvdutt]

Sorry! I failed to understand this completely because of the localization. Feel free to assign someone else. Thanks for the opportunity! 👍

[ythecombinator]

Hey @iGitScor, I noticed @dhruvdutt would rather work on code documentation and thought about working on this. I'd like to add these badges:

• Both Travis and Codeship _CI_s
• npm downloads and version
• dependencies and devDependencies

But since there's no continuous integration set up yet - and the package isn't published on npm -, I can do only the last two; should I open a PR with them?

[iGitScor]

@ythecombinator Of course, please feel free to make a pull request with your enhancement :wink:

Have you ever install code coverage tools ?

[iGitScor]

Hi @ythecombinator, did you have the time to work on this issue ?