From cba5a44be3a59c909959a55a081fc72f1db4aa48 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Mon, 16 Apr 2018 10:22:07 +0200 Subject: [PATCH] Improve grammar and spelling in README --- README.md | 50 +++++++++++++++++++++++--------------------------- 1 file changed, 23 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ad087da..d5f860c 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/c-bata/go-prompt)](https://goreportcard.com/report/github.com/c-bata/go-prompt) ![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square) -Library for building a powerful interactive prompt, inspired by [python-prompt-toolkit](https://github.com/jonathanslenders/python-prompt-toolkit). -More easy to build a multi-platform binary of the command line tools because written in Golang. +A library for building powerful interactive prompts inspired by [python-prompt-toolkit](https://github.com/jonathanslenders/python-prompt-toolkit), +making it easier to build cross-platform command line tools using Go. ```go package main @@ -30,7 +30,6 @@ func main() { } ``` - #### Projects using go-prompt * [c-bata/kube-prompt : An interactive kubernetes client featuring auto-complete written in Go.](https://github.com/c-bata/kube-prompt) @@ -38,7 +37,7 @@ func main() { * [kubicorn/kubicorn : Simple, cloud native infrastructure for Kubernetes.](https://github.com/kubicorn/kubicorn) * [cch123/asm-cli : Interactive shell of assembly language(X86/X64) based on unicorn and rasm2](https://github.com/cch123/asm-cli) * [ktr0731/evans : more expressive universal gRPC client](https://github.com/ktr0731/evans) -* (If you create a CLI using go-prompt and want your own project to be listed here, Please submit a Github Issue.) +* (If you create a CLI utility using go-prompt and want your own project to be listed here, please submit a GitHub issue.) ## Features @@ -56,42 +55,40 @@ go-prompt provides many options. Please check [option section of GoDoc](https:// ### Keyboard Shortcuts -Emacs-like keyboard shortcut is available by default (it's also default shortcuts in Bash shell). +Emacs-like keyboard shortcuts are available by default (these also are the default shortcuts in Bash shell). You can customize and expand these shortcuts. [![keyboard shortcuts](https://github.com/c-bata/assets/raw/master/go-prompt/keyboard-shortcuts.gif)](#keyboard-shortcuts) -KeyBinding | Description ---------------------|--------------------------------------------------------- -Ctrl + A | Go to the beginning of the line (Home) -Ctrl + E | Go to the End of the line (End) -Ctrl + P | Previous command (Up arrow) -Ctrl + N | Next command (Down arrow) -Ctrl + F | Forward one character -Ctrl + B | Backward one character -Ctrl + D | Delete character under the cursor -Ctrl + H | Delete character before the cursor (Backspace) -Ctrl + W | Cut the Word before the cursor to the clipboard. -Ctrl + K | Cut the Line after the cursor to the clipboard. -Ctrl + U | Cut/delete the Line before the cursor to the clipboard. -Ctrl + L | Clear the screen +Key Binding | Description +---------------------|--------------------------------------------------------- +Ctrl + A | Go to the beginning of the line (Home) +Ctrl + E | Go to the end of the line (End) +Ctrl + P | Previous command (Up arrow) +Ctrl + N | Next command (Down arrow) +Ctrl + F | Forward one character +Ctrl + B | Backward one character +Ctrl + D | Delete character under the cursor +Ctrl + H | Delete character before the cursor (Backspace) +Ctrl + W | Cut the word before the cursor to the clipboard +Ctrl + K | Cut the line after the cursor to the clipboard +Ctrl + U | Cut the line before the cursor to the clipboard +Ctrl + L | Clear the screen ### History -You can use up-arrow and down-arrow to walk through the history of commands executed. +You can use Up arrow and Down arrow to walk through the history of commands executed. [![History](https://github.com/c-bata/assets/raw/master/go-prompt/history.gif)](#history) - ### Multiple platform support -We confirmed go-prompt works fine on following terminals: +We have confirmed go-prompt works fine in the following terminals: * iTerm2 (macOS) * Terminal.app (macOS) * Command Prompt (Windows) -* GNU Terminal (Ubuntu) - +* gnome-terminal (Ubuntu) ## Links @@ -107,7 +104,6 @@ Masashi Shibata * Github: [@c-bata](https://github.com/c-bata/) * Facebook: [Masashi Shibata](https://www.facebook.com/masashi.cbata) -## LICENSE - -This software is licensed under the MIT License (See [LICENSE](./LICENSE) ). +## License +This software is licensed under the MIT license, see [LICENSE](./LICENSE) for more information.