updated readme.md file #10
Conversation
| A Node.js CLI command for searching for, or opening a YouTube video with Zen Audio Player. | ||
| A Node.js CLI tool for searching for, or opening a YouTube video with [Zen Audio Player](https://github.com/zen-audio-player/zen-audio-player.github.io). To use the zap-cli command-line tool, clone the repository and run a global npm install inside of it. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
append "shell" to this line to get syntax highlighting
|
Thanks for staring this! Overall great start, we can add in some formatting as I've commented on - I can do that work if you'd rather work on tests. The main thing I want in moving the npm installation/usage parts to their own PR, so we can merge them in just prior to release. |
| A Node.js CLI command for searching for, or opening a YouTube video with Zen Audio Player. | ||
|
|
||
| [](https://gitter.im/zen-audio-player/zen-audio-player.github.io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) | ||
| [](https://travis-ci.org/zen-audio-player/zen-audio-player.github.io) |
There was a problem hiding this comment.
Need to update the link here
|
Great, almost there! |
…still need to update correct badge links
| A Node.js CLI command for searching for, or opening a YouTube video with Zen Audio Player. | ||
|
|
||
| [](https://gitter.im/zen-audio-player/zen-audio-player.github.io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) | ||
| [](https://travis-ci.org/zen-audio-player/zap-cli) |
There was a problem hiding this comment.
The first link here should be https://api.travis-ci.org/zen-audio-player/zap-cli.svg?branch=master, emphasis on the .svg which sets up the image link
| ```shell | ||
| git clone https://github.com/zen-audio-player/zap-cli | ||
| cd zap-cli | ||
| npm install -g |
There was a problem hiding this comment.
Does this need to be npm install -g .? Also, what about this project's dependencies, do they get pulled in automatically by that command?
If I were doing this explicitly, I would do
git clone https://github.com/zen-audio-player/zap-cli
cd zap-cli
npm install
npm install -g .
Please manually verify the steps (ie: delete any local clones and start from scratch to make sure the steps work).
|
ping @thomasjosephgreco |
|
@shakeelmohamed just removed this from my computer and i found that the initial npm install isn't necessary. Below are the steps that installed it globally on my computer. |
|
Thanks, we're all set here! edit: made a fix to the travis CI badge, see dc575a1 |
No description provided.