Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CasperEngl committed Nov 8, 2019
1 parent c052db4 commit b4281c4
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Intro

This package uses [Puppeteer](https://www.npmjs.com/package/puppeteer) to start a headless browser session, which will then log into your account and scan for a search query in your downloadable modules.

# Installation

```
npm install -g opencart-find-module-cli
# or
yarn global add opencart-find-module-cli
```

# Usage

```
$ opencart-find-module
```

# Configuration

[Configstore](https://www.npmjs.com/package/configstore) is used to store your credentials on your local machine.

Configuration is stored at `~/.config/configstore/opencart-find-module.json`

0 comments on commit b4281c4

Please sign in to comment.