lepper
v0.0.3
Published
Help you understand project's structure easly.
Downloads
12
Maintainers
Readme
Lepper
Understand any project's structure easily.
Description
Lepper can be used by big projects to let people understand how the project is structured. With a few commands you can set/get a brief description of a project's structure and also find part of your project which is not described.
Installation
npm install lepper
Usage
We offer 4 commands that can help to achieve what's described above:
lepper init
: Initialize lepper in your project.lepper profile
: Set description to a directory.lepper describe
: Provides brief description of the project's directories.lepper verify
: Recursively checks and list undescribed directories.
Contributing
Thanks for considering contributing to this project. These are steps to contributing:
- Clone this repository.
- Run
npm describe
in root folder your project's clone. Just to understand how the project is structured. - Apply your logic
- Open a pull-request, we'll review and get back to you soon.
Also issues are welcomed.
License
This project is under MIT.
Maintainers
It was written by @pacifiquem and he's the current maintainer. If you want to contribute please refer to CONTRIBUTING.md