Skip to content
This repository has been archived by the owner on Feb 21, 2024. It is now read-only.

Commit

Permalink
Merge pull request #15 from cujarrett/update-install-docs
Browse files Browse the repository at this point in the history
fix(docs): adds more install info
  • Loading branch information
cujarrett authored Jan 24, 2021
2 parents 0af8177 + 7be6fac commit 59a6009
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,17 @@

## What is it?

Spellcheck CLI to quickly check the spelling of a word or two using the power of Google's search engine via a headless browser.
Spellcheck CLI to quickly check the spelling of a word or two using the power of Google's search
engine via a headless browser.

![demo](https://user-images.githubusercontent.com/16245634/103610858-adc8e180-4ee6-11eb-92c6-54d915ed7186.gif)

## Use

`spellcheckme` is best used as a globally installed Node package.
`spellcheckme` is best used as a globally installed Node package, and as such you'll need to have
[Node](https://nodejs.org/en/) installed. If you're on a Mac, I'd suggest using [Homebrew](https://brew.sh/)
for installing Node. Once you have Node installed, you can install and use `spellcheckme` as seen
below.

Install
```sh
Expand Down

0 comments on commit 59a6009

Please sign in to comment.