djyde/koy

README.md: add usage for locally installed koy

Open

#13 opened on Nov 7, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)CSS (10 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (97 stars)
PR merge metrics
 (No merged PRs in 30d)

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.

Contributor guide

Research direction
Add a section in README.md explaining how to use koy when installed locally via npm install (without g), including both node modules/.bin/koy and npx koy commands.
Tech stack
nodejs
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
npm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90