mod-support v1.2.0
mod-support
Simple command line access to frequently used documentation
Description
Module Documents Support (mod-support) is a simple Command Line Interface that provides easy terminal access to development tool documentation. Documentation links are stored in a publicly accessible database. Users are encouraged to contribute and curate the public repository of module documentation.
Content
The mod-support database was initially populated with 60+ frequently used modules and links to their primary documentation. This content is protected from deletion. All other content is user generated and user editable. Please use your best professional judgment when making updates to the content of this public resource.
Installation
- Command Line Installation
- Run the following command in the terminal: $
npm install -g mod-support-gFlag is used to install globally which will give access from any terminal location.
- Run the following command in the terminal: $
Usage
| Command | Description |
|---|---|
mod-support | Access the CLI overview |
mod-support list | Lists all modules currently in the database |
mod-support l | Shorthand command for list |
mod-support contribute | Allows the user to contribute a new module to the database |
mod-support c | Shorthand command for contribute |
mod-support update | Allows the user to add an additional document URL to an existing module |
mod-support u | Shorthand command for update |
mod-support delete | Allows the user to delete community generated content |
mod-support d | Shorthand command for delete |
-h | Added to any other command will provide help for the chosen command |
Contributors
- Mariko Alvarado
- Ricardo Barcenas
- Stacy Burris
- Simon Panek
License
Copyright 2021
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.