djyde/koy

README.md: add usage for locally installed koy

Offen

#13 geöffnet am 07.11.2018

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)CSS (10 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (97 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Fügen Sie im README.md einen Abschnitt hinzu, der erklärt, wie koy bei lokaler Installation über npm install (ohne g) verwendet wird, einschließlich der Befehle node modules/.bin/koy und npx koy.
Tech Stack
nodejs
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
npm
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90