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 1 commit
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
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# zap-cli
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.
Copy link
Member

Choose a reason for hiding this comment

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

From "To use"... on, let's break that into a new section called usage. The markdown is:

## Usage

To use ...

Copy link
Member

Choose a reason for hiding this comment

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

Still need the" usage" h2 after the first sentence here, see my previous comment

Copy link
Author

Choose a reason for hiding this comment

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

@shakeelmohamed alright, took a few tries but I think I got it 😄


```
Copy link
Member

Choose a reason for hiding this comment

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

append "shell" to this line to get syntax highlighting

git clone https://github.com/zen-audio-player/zap-cli && cd zap-cli
Copy link
Member

Choose a reason for hiding this comment

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

Let's do 1 command per line, I love using && but it doesn't belong in a README

Copy link
Member

Choose a reason for hiding this comment

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

Use another command line instead of &&

npm install -g
```

You can also access the zap command-line tool via the [zap-cli npm package](
Copy link
Member

Choose a reason for hiding this comment

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

Can you move the npm related content to another branch? (And subsequently, a new pr) I want to merge everything in that's 100% true right now, then before we publish to npm I can merge in the changes relating to npm installation/usage

https://www.npmjs.com/package/zap-cli). In order to use the zap-cli package globally, you must change into the directory of the package where you will then need to install it globally. Below is an example of installing zap-cli via npm.

```
Copy link
Member

Choose a reason for hiding this comment

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

shell

npm install zap-cli
Copy link
Member

Choose a reason for hiding this comment

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

All of these steps should just be npm install -g zap-cli once I've published the package to npm

zap-cli@1.0.0 /usr/local/lib/node_modules/zap-cli
└── open@0.0.5
cd /usr/local/lib/node_modules/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://g.recordit.co/KXdK5O5sPJ.gif)
Copy link
Member

Choose a reason for hiding this comment

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

Can we use this as the demo for consistency?