djyde/koy

README.md: add usage for locally installed koy

Ouverte

#13 ouverte le 7 nov. 2018

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)CSS (10 forks)github user discovery
enhancementhelp wanted

Métriques du dépôt

Stars
 (97 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

User might not want to pollute their global environment with npm install koy -g and choose to install locally via npm install koy. That way, users need to invoke koy this way:

node_modules/.bin/koy FILENAME.md

or alternatively,

npx koy FILENAME.md

npx is a utility of NPM. It will check the node_modules in the current directory for the executable. If not found, it will automatically download the package.

By the way, Carlo author's team members send their regards.

Guide contributeur

Direction de recherche
Ajoutez une section dans README.md expliquant comment utiliser koy lorsqu'il est installé localement via npm install (sans g), y compris les commandes node modules/.bin/koy et npx koy.
Stack technique
nodejs
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
npm
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90