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

Commit

Permalink
Fix/readme screens (#163)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Update template.go

* Update README.md
  • Loading branch information
AlecAivazis authored Nov 15, 2018
1 parent 16d63be commit 1fa814d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

A library for building interactive prompts.

<img width="500" src="https://thumbs.gfycat.com/VillainousGraciousKouprey-size_restricted.gif"/>
<img width="550" src="https://thumbs.gfycat.com/VillainousGraciousKouprey-size_restricted.gif"/>

```go
package main
Expand Down Expand Up @@ -93,7 +93,7 @@ go run examples/validation.go

### Input

<img src="https://media.giphy.com/media/3og0IxS8JsuD9Z8syA/giphy.gif" width="400px"/>
<img src="https://thumbs.gfycat.com/LankyBlindAmericanpainthorse-size_restricted.gif" width="400px"/>

```golang
name := ""
Expand All @@ -105,7 +105,7 @@ survey.AskOne(prompt, &name, nil)

### Password

<img src="https://media.giphy.com/media/26FmQr6mUivkq71GE/giphy.gif" width="400px" />
<img src="https://thumbs.gfycat.com/CompassionateSevereHypacrosaurus-size_restricted.gif" width="400px" />

```golang
password := ""
Expand All @@ -117,7 +117,7 @@ survey.AskOne(prompt, &password, nil)

### Confirm

<img src="https://media.giphy.com/media/3oKIPgsUmTp4m3eo4E/giphy.gif" width="400px"/>
<img src="https://thumbs.gfycat.com/UnkemptCarefulGermanpinscher-size_restricted.gif" width="400px"/>

```golang
name := false
Expand All @@ -129,7 +129,7 @@ survey.AskOne(prompt, &name, nil)

### Select

<img src="https://media.giphy.com/media/3oKIPxigmMu5YqpUPK/giphy.gif" width="400px"/>
<img src="https://thumbs.gfycat.com/GrimFilthyAmazonparrot-size_restricted.gif" width="450px"/>

```golang
color := ""
Expand All @@ -153,7 +153,7 @@ prompt := &survey.Select{..., PageSize: 10}

### MultiSelect

<img src="https://media.giphy.com/media/3oKIP8lHYFtGeQDH0c/giphy.gif" width="400px"/>
<img src="https://thumbs.gfycat.com/SharpTameAntelope-size_restricted.gif" width="450px"/>

```golang
days := []string{}
Expand Down Expand Up @@ -215,7 +215,7 @@ validators include:

All of the prompts have a `Help` field which can be defined to provide more information to your users:

<img src="https://media.giphy.com/media/l1KVbc5CehW6r7pss/giphy.gif" width="400px" style="margin-top: 8px"/>
<img src="https://thumbs.gfycat.com/CloudyRemorsefulFossa-size_restricted.gif" width="400px" style="margin-top: 8px"/>

```golang
&survey.Input{
Expand Down Expand Up @@ -283,12 +283,12 @@ in `survey/core`:

| name | default | description |
| ------------------ | ------- | ------------------------------------------------------------- |
| ErrorIcon | | Before an error |
| HelpIcon | | Before help text |
| ErrorIcon | X | Before an error |
| HelpIcon | i | Before help text |
| QuestionIcon | ? | Before the message of a prompt |
| SelectFocusIcon | | Marks the current focus in `Select` and `MultiSelect` prompts |
| MarkedOptionIcon | | Marks a chosen selection in a `MultiSelect` prompt |
| UnmarkedOptionIcon | | Marks an unselected option in a `MultiSelect` prompt |
| SelectFocusIcon | > | Marks the current focus in `Select` and `MultiSelect` prompts |
| UnmarkedOptionIcon | [ ] | Marks an unselected option in a `MultiSelect` prompt |
| MarkedOptionIcon | [x] | Marks a chosen selection in a `MultiSelect` prompt |

## Versioning

Expand Down
2 changes: 1 addition & 1 deletion core/template.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ var (
ErrorIcon = "X"

// HelpIcon will be shown before more detailed question help
HelpIcon = "????"
HelpIcon = "?"
// QuestionIcon will be shown before a question Message
QuestionIcon = "?"

Expand Down

0 comments on commit 1fa814d

Please sign in to comment.