docgen-x

docgen-x - a CLI to create various License files for Projects

Usage no npm install needed!

<script type="module">
  import docgenX from 'https://cdn.skypack.dev/docgen-x';
</script>

README

docgen-x

GitHub release (latest SemVer) GitHub issues GitHub stars GitHub last commit Lines of code License

docgen-ximg

A CLI to create various License files for Projects with ease.

Installation

$ npm install docgen-x

Highlights

  • Creates License files effectively and fast.
  • With docgen-x, Licensing is a matter of seconds.

List of commands

docgen-x currently provides 8 commands,

  1. docgen

    This command is not a workflow command and it just displays the name.

  2. docgen-v

    This command displays the current version of the docgen-x.

  3. docgen-help

    This command provide help.

  4. docgen-m

    This command creates a MIT license file instantly with the filename you give.

  5. docgen-a

    This command creates a APACHE 2.0 license file instantly with the filename you give.

  6. docgen-g3

    This command creates a GNU 3.0 license file instantly with the filename you give.

  7. docgen-g2

    This command creates a GNU 2.0 license file instantly with the filename you give.

  8. docgen-bsd2

    This command creates a BSD 2-clause "Simplified" license file instantly with the filename you give.

Usage

Example 1

If you type docgen-m MITSAMPLE.md in terminal/bash, A new .md file with name "MITSAMPLE" containing MIT License statement will be created in the current working directory.

Example 2

If you type docgen-a APACHESAMPLE.md in terminal/bash, A new .md file with name "APACHESAMPLE" containing APACHE 2.0 License statement will be created in the current working directory.

License

MIT License

Copyright (c) 2021 Vishwa.R

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.