Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme.md file #10

Merged
merged 6 commits into from
Feb 24, 2016
Merged

updated readme.md file #10

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1020b89
updated readme.md file
Feb 15, 2016
011c4a6
removed all npm related info && changed demo to glitchmob youtube url
Feb 15, 2016
cf26327
added license info + badges to travis, glitter, github stats
Feb 15, 2016
730d013
split shell code from using double ampersands to a seperate line.... …
Feb 16, 2016
fd35fe1
Added correct links to github stats and travis CI
Feb 16, 2016
5992d10
Added correct travis CI badge with SVG + Created usage section
Feb 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# zap-cli
A Node.js CLI command for searching for, or opening a YouTube video with Zen Audio Player.

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/zen-audio-player/zen-audio-player.github.io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Build Status]https://api.travis-ci.org/zen-audio-player/zap-cli.svg?branch=master)](https://travis-ci.org/zen-audio-player/zap-cli)
[![GitHub Stats](https://img.shields.io/badge/github-stats-ff5500.svg)](http://githubstats.com/zen-audio-player/zap-cli)

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).

## Usage
To use the zap-cli command-line tool, clone the repository and run a global npm install inside of it.

```shell
git clone https://github.com/zen-audio-player/zap-cli
cd zap-cli
npm install -g
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

```

Once done, you will then have access to the `zap` command globally throughout your computer. Below, you can see the zap-cli in action.

![Zap command line tool Example](http://recordit.co/RnfhYEq1Hp.gif)


## License

zap-cli is licensed under the MIT license.