create-readme-tiz

Create conventional Readme with specified techno

Usage no npm install needed!

<script type="module">
  import createReadmeTiz from 'https://cdn.skypack.dev/create-readme-tiz';
</script>

README

Create Readme

npm-create-readme

  • Node.js 10.15.3
  • Status DEV

Table of contents

About the project

Contributors

  • Developers : Alexis BARDONNET
  • Designer : /
  • Project manager : /
  • Marketing : /
  • Commercial : /

Description

With this module, You can directly download a conventional README for your projects.

Plugins

  • node-fetch 2.6.1

Environments

Getting started

Prerequisites

  • Node.js

https://nodejs.org/en/download/

  • npm
$ npm install npm@latest -g

Installation

  1. Install dependencies
$ npm install

Credentials

No credentials needed

Test and deploy

Use in local

To use the script in local (from this project repository), run :

$ npm link

Install the script from npm

To install the script from npm, run :

$ sudo npm install -g create-readme-tiz

Run

To run the script, use :

$ readme [key]

Values of [key] :

  • drupal
  • flutter
  • laravel
  • prestashop
  • symfony
  • reactjs
  • standard
  • wordpress
  • xamarin

Deploy

To deploy the plugin, logging as Tiz npm user (available in lastpass), and run the command :

$ npm publish .

Don't forget to update the version number in package.json.