Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PythonicNinja committed Mar 29, 2018
1 parent 9c10e72 commit becf408
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sufler

Sufler - is the tool to help you with generating bash/zsh/powershell/fish autocompletions from yml file.
Sufler - is the tool to help you with generating bash/zsh/powershell/fish autocompletions from YAML file.

[![Build Status](https://travis-ci.org/limebrains/sufler.svg?branch=master)](https://travis-ci.org/limebrains/sufler)
[![coveralls](https://coveralls.io/repos/limebrains/sufler/badge.svg?branch=master&service=github)](https://coveralls.io/github/limebrains/sufler?branch=master)
Expand All @@ -9,16 +9,17 @@ Sufler - is the tool to help you with generating bash/zsh/powershell/fish autoco
[Documentation](http://sufler.readthedocs.io/en/latest/?badge=latest)

## Quickstart:
```
sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/limebrains/sufler/master/install.bash)"
```

or

```bash
pip install sufler
```

or

```
sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/limebrains/sufler/master/install.bash)"
```

you will have directory in your home dir where you can install your custom completions.
```
/Users/pythonicninja/.sufler/
Expand All @@ -28,6 +29,9 @@ you will have directory in your home dir where you can install your custom compl
└── .config
```

there is repo which accepts PR's with common completions
[sufler-completions - github.com](https://github.com/limebrains/sufler-completions)

## Key ideas:

### Example yml file:
Expand All @@ -42,6 +46,7 @@ you will have directory in your home dir where you can install your custom compl
'--install-option':
'<Exec> wget https://pypi.python.org/simple/ -O ~/.sufler/python_completions -c -q && cat ~/.sufler/python_completions | cut -d ">" -f 2 | cut -d "<" -f 1 | grep "^TREE~1.*"': *install
```
[full raw file](https://raw.githubusercontent.com/limebrains/sufler-completions/master/completions/pip.yml)

Please notice special names of keys such as:

Expand All @@ -53,10 +58,10 @@ Please notice special names of keys such as:

- `<Run>`

All of them are documented in details - [http://sufler.readthedocs.io/en/latest/user/advanced.html](documentation of advanced features)
[All of them are documented in details - readthedocs.io](http://sufler.readthedocs.io/en/latest/user/advanced.html)

### Origin of the name
Name comes from (pol. sufler - [https://pl.wikipedia.org/wiki/Sufler](sufler))
Name comes from (pol. sufler - [wiki](https://pl.wikipedia.org/wiki/Sufler))
> The prompter (sometimes prompt) in a theatre is a person who prompts or cues actors when they forget their lines or neglect to move on the stage to where they are supposed to be situated.
![sufler](https://i.imgur.com/MWrtIhi.jpg)

0 comments on commit becf408

Please sign in to comment.