From 00d1e08ec5ec69395d4d41b64f7fa3e3ea1ec324 Mon Sep 17 00:00:00 2001
From: Kirstie Whitaker <kw401@cam.ac.uk>
Date: Thu, 18 Oct 2018 16:59:10 +0100
Subject: [PATCH] docs: add note about using npx cli command (#114)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

<!--
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!

Please make sure that you are familiar with and follow the Code of Conduct for
this project (found in the CODE_OF_CONDUCT.md file).

Also, please make sure you're familiar with and follow the instructions in the
contributing guidelines (found in the CONTRIBUTING.md file).

If you're new to contributing to open source projects, you might find this free
video course helpful: http://kcd.im/pull-request

Please fill out the information below to expedite the review and (hopefully)
merge of your pull request!
-->

<!-- What changes are being made? (What feature/bug is being fixed here?) -->
**What**: Add a couple of sentences about running the from the command line with `npx` - they're almost verbetim the "heads up" that @kentcdodds suggested in https://github.com/jfmengels/all-contributors-cli/issues/92#issuecomment-391766876..

<!-- Why are these changes necessary? -->
**Why**: I was having difficulty understanding how to run the commands and I found this text in issue #92 super helpful - I figured it would be for others too 😄

<!-- How were these changes implemented? -->
**How**: Updated text in README

<!-- Have you done all of these things?  -->
**Checklist**:
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
- [x] Documentation
- [ ] Tests -- NA
- [x] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
- [ ] Added myself to contributors table -- ironically I'm not sure how to do this 🤣 <!-- this is optional, see the contributing guidelines for instructions -->

<!-- feel free to add additional comments -->
---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 58ecdad..6756db7 100644
--- a/README.md
+++ b/README.md
@@ -81,6 +81,10 @@ npm run contributors:generate
 
 ## Usage
 
+A quick note: We recommend that you install `all-contributors-cli` as a dependency in your project.
+If you do that then you can run the `all-contributors` binary from within your `package.json` scripts, or you can run it in your terminal with `npx all-contributors`.
+Below we'll just show `all-contributors` to keep things simple, but if you're having any difficulties, then give the `npx all-contributors-cli` route a try :smiley_cat:
+
 ### Generating the contributors list
 
 Please add following placeholders in [`files`](#configuration) to specify the generation area first.