Skip to content

Commit

Permalink
chore: fix bug with autocomplete, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rheaditi committed Nov 15, 2020
1 parent 630aca9 commit 0a3cf39
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<img width="570" alt="Banner" src="https://user-images.githubusercontent.com/6417910/99180829-a8a1ae80-274f-11eb-9b19-ef8ed796bc83.png">
</div>

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
![CI](https://github.com/campvanilla/ditto/workflows/Unit%20Tests%20CI/badge.svg?branch=main&event=push) ![npm (scoped)](https://img.shields.io/npm/v/@campvanilla/ditto-cli?style=flat) ![GitHub](https://img.shields.io/github/license/campvanilla/ditto?color=yellow&style=flat) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

## ditto
Expand All @@ -12,7 +12,6 @@
![BannerGif](https://user-images.githubusercontent.com/6417910/99155780-1662c180-26e1-11eb-92b8-7ae6c2fb22a2.gif)


## Usage

### System requirements
Expand All @@ -21,21 +20,25 @@

Tested on macOS, Linux and Windows (via [Windows Terminal](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab))

### Installation
### Running / Installation

Install the cli globally via npm
We recommend using `npx` to run the CLI:-

```bash
npx @campvanilla/ditto-cli
```

Or, alternatively, install it globally via npm and then run:-

```bash
$ npm install -g @campvanilla/ditto-cli

$ ditto-cli
```

**Recommendation:** Since the usage of this cli is probably infrequent, we recommend using `npx` to run the cli rather than installing the package globally
### Setting in iTerm2

```bash
npx @campvanilla/ditto-cli
```
Once an iterm color scheme file is generated, `Cmd + Click` on the _file name_ (with extension as `*.itermcolors`) in `iTerm2` to automatically import the preset into iTerm & then select the theme from preferences (`Cmd + i``Colors` tab → `Color Presets` → Select the generated color preset).

### Custom Options

Expand Down
1 change: 0 additions & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ async function main() {
const prompt = new AutoComplete({
name: 'themes',
message: 'Select the vscode theme:',
limit: 10,
choices: Object.keys(themes),
});

Expand Down

0 comments on commit 0a3cf39

Please sign in to comment.