djyde/koy

README.md: add usage for locally installed koy

Aberta

#13 aberto em 7 de nov. de 2018

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)CSS (10 forks)github user discovery
enhancementhelp wanted

Métricas do repositório

Stars
 (97 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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.

Guia do colaborador

Direção de pesquisa
Adicione uma seção no README.md explicando como usar o koy quando instalado localmente via npm install (sem g), incluindo os comandos node modules/.bin/koy e npx koy.
Pilha de tecnologia
nodejs
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
npm
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90